Repository navigation
feat: Doku onboarding checklist for new users - #93
Merged
Merged
Conversation
Add the 12-principles-of-animation, better-ui and emil-design-eng agent skills and record them in skills-lock.json. They guide motion, press feedback and surface polish for dashboard UI work.
New accounts get an onboarding start date, so existing users never see the checklist. GET and PATCH /auth/onboarding return the checklist state and record snooze, resume, dismiss and complete events. Only the commit-type confirmation and those events are stored. Whether a repository is on and whether the first README has run are read from the active repos and logs, so the steps always match what actually happened. A deactivated repository no longer counts as connected, and a skipped first run counts as a finished README.
New users get a quiet getting-started checklist, guided by the Doku mascot, in place of the old localStorage banners and modals: 1. Choose how README updates land (Direct or Pull Request). 2. Turn on a first repository, with the trust guarantees spelled out. 3. Watch the first README being written, with live progress from the worker's log stream. The checklist follows the user across dashboard pages, folds into a corner launcher and can be hidden for good. Its state comes from the server, so it no longer replays on a new browser or device. The Cleanup announcement is now only shown to accounts that predate onboarding. Motion follows the project's design skills: staged entrances, a 0.96 press on every control, cross-faded state changes and a one-off celebration, all reduced to opacity fades under prefers-reduced-motion. Also adds the seven Doku poses (PNG masters plus cropped WebP exports) and the ChatGPT prompt sheets used to make them, and moves the commit type into a shared store so the toolbar toggle and the checklist stay in sync.
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
|
Note Currently processing new changes in this PR. This may take a few minutes, please wait... ⚙️ Run configuration
⛔ Files ignored due to path filters (7)
📒 Files selected for processing (46)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
This branch was successfully deployed
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.
What
Replaces the old first-run walkthrough (localStorage banners, a modal and a dashed repo highlight) with a quiet getting-started checklist guided by Doku, the new mascot.
New users see three steps in a panel that follows them across the dashboard:
[skip ci]commits, turn off anytime).The panel folds into a corner launcher ("I'll finish later") or can be hidden for good. When every step is done it shows a one-off "All set" celebration.
How it works
onboarding.startedAt, so existing users never see the checklist.GET /auth/onboardingderives steps 2 and 3 from active repos and logs, so they can't drift from reality.PATCH /auth/onboardingrecords snooze, resume, dismiss and complete. Saving a commit type marks step 1.OnboardingProviderinDashboardLayoutpolls only while the first README is on its way. The commit type moved into a shared store, so the toolbar toggle and the checklist stay in sync. The Cleanup spotlight now only shows to accounts that predate onboarding.better-ui,emil-design-eng,12-principles-of-animation):prefers-reduced-motionlogo-candidates/doku/and 12–16 KB WebP exports inclient/public/doku/, plus the ChatGPT prompt sheets used to make them inlogo-candidates/doku-prompts/.Testing
pnpm test: 161 server tests pass, including 16 new onboarding tests.pnpm lint,pnpm typecheck,pnpm format:checkandpnpm buildall pass.Not verified: the reduced-motion OS setting and phone-width layout.
Deploy note
Merging to
maintriggers the EC2 API deploy (ci.yml). The schema change is additive. Existing users have noonboarding.startedAtand are unaffected.Summary by CodeRabbit