feat(onboarding): guided management and board tours#5756
Open
ajnart wants to merge 19 commits into
Open
Conversation
Co-authored-by: homarr-renovate[bot] <158783068+homarr-renovate[bot]@users.noreply.github.com>
Co-authored-by: homarr-renovate[bot] <158783068+homarr-renovate[bot]@users.noreply.github.com>
Co-authored-by: homarr-renovate[bot] <158783068+homarr-renovate[bot]@users.noreply.github.com>
Co-authored-by: homarr-renovate[bot] <158783068+homarr-renovate[bot]@users.noreply.github.com>
Co-authored-by: homarr-renovate[bot] <158783068+homarr-renovate[bot]@users.noreply.github.com>
Persist completedManageTour and completedBoardTour on the user table with renamed migrations across sqlite, mysql, and postgresql.
Expose getTourStatus, completeTour, and resetTours for persisting per-user management and board tour completion.
Register onboarding tour stylesheet and align lockfile with Mantine v9.
Introduce TourShell with step counter, Enter key support, route-aware advancement, and TourTarget wrappers. Remove unused fork and hold-skip steps.
Guide admins through boards, apps, integrations, and users with per-page steps, TourTarget highlights, optimistic completion, and reset in settings.
Scope the board tour to content pages, target header actions, remove the loading overlay, and persist completion with optimistic cache updates.
Add per-page management tour strings and update board tour descriptions.
Dokploy Preview Deployment
|
Use OnboardingTourController and guard optional step index. Type users step focus reveal props for FloatingPosition compatibility.
Co-authored-by: homarr-renovate[bot] <158783068+homarr-renovate[bot]@users.noreply.github.com>
manuel-rw
approved these changes
May 28, 2026
| return ( | ||
| <Box h="100%" pos="relative"> | ||
| <BoardBackgroundVideo /> | ||
| <LoadingOverlay |
Member
Author
There was a problem hiding this comment.
No, this was another overlay that blocked the tour from appearing, so since I made the other PR that also removes it (it's not needed) then I figured I'll remove it in this one too
|
|
||
| import type { ReactNode } from "react"; | ||
| import { usePathname } from "next/navigation"; | ||
| import { OnboardingTour } from "@gfazioli/mantine-onboarding-tour"; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Requires #5411
Notes
Most of this PR is kind of prof of concept. I am aware it's not perfect and the code probably not up to standard, it's kind of a proof of concept on what we could do to help new users quickly get their hands on with the app.
Summary
completedManageTour,completedBoardTour) with tRPC APIs to complete, reset, and query status.TourShellwith step counter, Enter key for Next/Done (↵ indicator), route-aware navigation, andTourTargetwrappers for the Mantine onboarding tour library./manage, boards, apps, integrations, and users (admin) with two steps per page (list + create).demo
CleanShot.2026-05-20.at.09.56.33.mp4
Demo creds
demo : feu5wbx*YGD1ayf_tvu
Test plan
/manage— management tour starts on home, navigates each sub-page, Enter advances steps, Done completes without restarting.smbreakpoint.