Skip to content

docs: cover keyboard-only, onboarding tour, and failed-job self-heal - #2724

Draft
cursor[bot] wants to merge 2 commits into
mainfrom
cursor/engineering-documentation-automation-dfff
Draft

docs: cover keyboard-only, onboarding tour, and failed-job self-heal#2724
cursor[bot] wants to merge 2 commits into
mainfrom
cursor/engineering-documentation-automation-dfff

Conversation

@cursor

@cursor cursor Bot commented Aug 10, 2026

Copy link
Copy Markdown
Contributor

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 stale useGlobalShortcuts path; day-column / all-day tint / account header pointers; failed-job self-heal entry
  • docs/acceptance/shortcuts.md — Shift-Shift keyboard-only scenario, spatial arrow focus, palette undo/redo + restart tour, regression checklist
  • docs/frontend/frontend-runtime-flow.md — Welcome → onboarding tour + keyboard-only mount contract
  • docs/development/common-change-recipes.md — recipe for adding/changing shortcuts safely
  • docs/features/google-sync-and-sse-flow.md + docs/self-hosting/monitoring.md — failed-job self-heal / durable auto-clear operator notes
  • docs/README.md — discoverability links for shortcuts and onboarding

Codepaths 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 restart
  • packages/web/src/grid/shortcuts/focus-adjacent-grid-event.ts (spatial focus)
  • packages/sync/src/domain/failed-job-requeue.service.ts + sweep wiring in packages/sync/src/app.ts
  • bun run cli manage-failed-jobs operator path (already documented in cli.md)

Key knowledge gaps addressed

  • Keyboard-only mode (Shift-Shift) had only a one-line mention; now has acceptance coverage and file map pointers
  • Onboarding tour was undocumented after shipping
  • Feature file map still pointed at a removed views/Week/.../useGlobalShortcuts path
  • Sync durable failed-job auto-clear (fix(sync): clear exhausted jobs blocked by durable read failures #2712) was only in CLI notes; sync flow + monitoring now describe the self-heal loop

Simplicity

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 17 weekday focus (replaced by Shift day-prefix jump).

Test plan

  • Verified referenced file paths exist on disk
  • Spot-checked user-visible labels against CommandPalette / registry source
  • No package tests required (documentation-only)
Open in Web View Automation 

cursoragent and others added 2 commits August 10, 2026 16:04
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>
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.

1 participant