Skip to content

feat: add guided onboarding tour (WIP)#125

Draft
lulkebit wants to merge 2 commits into
Blur009:devfrom
lulkebit:feature/onboarding-tour
Draft

feat: add guided onboarding tour (WIP)#125
lulkebit wants to merge 2 commits into
Blur009:devfrom
lulkebit:feature/onboarding-tour

Conversation

@lulkebit
Copy link
Copy Markdown
Contributor

Summary

Adds an interactive guided onboarding tour using driver.js. The tour launches automatically on first launch and can be restarted anytime via the Settings panel. It walks users through all major features across the Simple tab, Advanced tab, and Settings, including cadence, hotkey, mouse button, duty cycle, speed variation, limits, failsafe, and theme/preset options.

The tour is tracked via a persistent onboardingCompleted flag in the settings store. A "Start Tour" button has been added to the Settings panel for manual restarts. Popover styles are fully themed using the app's existing CSS variables.

⚠️ This is a work in progress and not yet ready for merge. The overlay positioning in Simple mode does not feel quite right yet and needs further refinement. If anyone wants to jump in and help improve the tour steps or styling, feel free to do so. Contributions are very welcome!

Related issue

N/A

Testing

Tested locally on macOS via the test/onboarding-tour branch which merges this feature with macOS support. Frontend (TypeScript + Vite) builds cleanly. A full tauri build requires Windows as this feature is built on top of the Windows-only upstream dev branch.

First-launch auto-trigger works correctly. Manual restart via Settings works. Tab switching between Simple, Advanced and Settings during the tour works. The onboardingCompleted flag persists correctly across restarts.

Checklist

  • I tested the change locally
  • I kept the change focused and relevant
  • I updated any related documentation if needed

- Add OnboardingTour component with 13 steps across all three tabs
- Tour auto-starts on first launch (onboardingCompleted flag in settings)
- Manual restart available via 'Start Tour' button in Settings
- Smooth tab navigation between Simple → Advanced → Settings
- Custom CSS theme matching app dark/light mode via CSS variables
- data-tour attributes added to key UI elements for precise targeting

Made-with: Cursor
@Blur009
Copy link
Copy Markdown
Owner

Blur009 commented Apr 21, 2026

uu im interested in this one.. keep in mind that 3.5 will change ui a lot so you might want to wait after that.. but thats your choice

@lulkebit
Copy link
Copy Markdown
Contributor Author

the feature branch is basend on the current dev branch so should be fine, no?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants