docs: cover keyboard-only, onboarding tour, and failed-job self-heal - #2724
Draft
cursor[bot] wants to merge 2 commits into
Draft
docs: cover keyboard-only, onboarding tour, and failed-job self-heal#2724cursor[bot] wants to merge 2 commits into
cursor[bot] wants to merge 2 commits into
Conversation
Bring discoverability and acceptance docs in line with the recent web shortcut/onboarding work and Sync's durable failed-job auto-clear path. Co-authored-by: Tyler Dane <tyler-dane@users.noreply.github.com>
Co-authored-by: Tyler Dane <tyler-dane@users.noreply.github.com>
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.
Summary
Bring engineering docs in line with recent web shortcut/onboarding work and Sync’s durable failed-job self-heal path. Updates existing pages only (no new doc trees).
Docs added/updated
docs/development/feature-file-map.md— Keyboard Shortcuts + Onboarding Tour sections; fixed staleuseGlobalShortcutspath; day-column / all-day tint / account header pointers; failed-job self-heal entrydocs/acceptance/shortcuts.md— Shift-Shift keyboard-only scenario, spatial arrow focus, palette undo/redo + restart tour, regression checklistdocs/frontend/frontend-runtime-flow.md— Welcome → onboarding tour + keyboard-only mount contractdocs/development/common-change-recipes.md— recipe for adding/changing shortcuts safelydocs/features/google-sync-and-sse-flow.md+docs/self-hosting/monitoring.md— failed-job self-heal / durable auto-clear operator notesdocs/README.md— discoverability links for shortcuts and onboardingCodepaths covered
packages/web/src/shortcuts/**(registry, shift-tap gesture, shift-hint, keyboard-only, global shell shortcuts)packages/web/src/components/OnboardingTour/**+ Welcome Start Now / command-palette restartpackages/web/src/grid/shortcuts/focus-adjacent-grid-event.ts(spatial focus)packages/sync/src/domain/failed-job-requeue.service.ts+ sweep wiring inpackages/sync/src/app.tsbun run cli manage-failed-jobsoperator path (already documented incli.md)Key knowledge gaps addressed
views/Week/.../useGlobalShortcutspathSimplicity
Prefer updating existing docs over new pages. No implementation-detail dumps; verified behavior against source before writing.
Automated validation
Docs-only change. Cross-checked paths and behaviors against current source (
shortcuts.registry.ts,useKeyboardOnlyMode, onboarding tour steps/store,failed-job-requeue.service.ts, command palette labels).Independent review
Self-reviewed against recent main commits (#2697–#2722) and existing docs style. Intentionally omitted superseded digit
1–7weekday focus (replaced by Shift day-prefix jump).Test plan
CommandPalette/ registry source