Skip to content

feat: add first-run guided tour to the generated report, with entry-node pulse - #16

Merged
askuma merged 1 commit into
mainfrom
feat/first-run-guided-tour
Jul 24, 2026
Merged

feat: add first-run guided tour to the generated report, with entry-node pulse#16
askuma merged 1 commit into
mainfrom
feat/first-run-guided-tour

Conversation

@askuma

@askuma askuma commented Jul 24, 2026

Copy link
Copy Markdown
Owner

Summary

  • Adds a spotlight walkthrough that auto-launches the first time a generated WORKFLOW.html is opened, stepping through every section (stat row, derivation, codebase graph, architecture, flows, concurrency, bottlenecks, theme toggle); replayable via a new ? button. Steps are skipped at runtime for sections a project doesn't have.
  • Adds a radar-ping pulse/glow on the codebase graph's entry node the first time it's actually visible and clickable, gated so it never plays during the guided tour (including a timing race where the graph's IntersectionObserver fires before the tour's auto-launch delay elapses). Ring/glow uses a theme-aware color so it's visible in both light and dark mode.
  • Updates README/SKILL/INSTALL "output sections" lists to document the guided tour.

docs/index.html is intentionally untouched here — it's already being regenerated in #15 for the graph feature, and only stale-content changes are picked up there to avoid churn across the two PRs.

Test plan

  • python3 -m py_compile workflow_generator_mcp/analyze.py
  • python3 -m pytest tests/ -q — 80 passed
  • Playwright: tour steps land on the right element in both themes, off-screen card bug fixed for oversized sections, Back/Next/Skip/×/Esc/restart all work, localStorage suppresses auto-launch on reload
  • Playwright: confirmed no-routes and no-graph projects skip the corresponding tour steps with correct step counts
  • Playwright: pulse ring/glow visible in both themes, lasts ~10s, does not arm while the tour overlay is blocking clicks, arms correctly once the user revisits the graph after the tour ends

…ode pulse

Every generated WORKFLOW.html now launches a spotlight walkthrough the first
time it's opened, dimming the page and stepping through each section in turn
(stat row, derivation, codebase graph, architecture, flows, concurrency,
bottlenecks, theme toggle). Steps for sections a project doesn't have (no
detected routes, no graph) are skipped automatically at runtime. Replayable
anytime via a new "?" button next to the theme toggle; the tour is otherwise
suppressed after first dismissal via localStorage.

The codebase graph's entry node also gets a radar-ping pulse/glow the first
time the graph is actually visible and clickable, to make it read as "start
here." The pulse is gated on the guided tour not being active -- including a
timing race where the graph's IntersectionObserver fires before the tour's
auto-launch delay elapses -- so it never plays out during the window when the
tour overlay would block the click it's inviting. Ring/glow color is
theme-aware so it reads in both light and dark mode.
@askuma
askuma merged commit 2009a2d into main Jul 24, 2026
3 checks passed
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