Skip to content

docs(web): add web-ui.md reference and update web/README.md#21

Merged
Gsbreddy merged 1 commit into
mainfrom
cursor/codebase-documentation-alignment-ca72
May 2, 2026
Merged

docs(web): add web-ui.md reference and update web/README.md#21
Gsbreddy merged 1 commit into
mainfrom
cursor/codebase-documentation-alignment-ca72

Conversation

@cursor
Copy link
Copy Markdown

@cursor cursor Bot commented May 2, 2026

Docs added/updated

docs/web-ui.md (new)

Full developer reference for the React app that shipped in PR #17 but had no dedicated documentation:

  • Routing table — HashRouter path → component → HTTP calls
  • Component tree — visual diagram of App → AppShell → TimelineRefreshProvider → pages
  • TimelineRefreshContext — explains the generation counter pattern, when to call notifyTimelineMutated(), and the end-to-end data flow for post-mutation timeline refresh
  • Per-page referenceOverviewPage, DiffPage, ActionsPage: fields, defaults, state management, error handling, auth behavior
  • api.ts helpersfetchJson<T> auth injection / error extraction, loadTimeline() parallel fan-out, all exported TypeScript types
  • Shared componentsBadge and JsonPanel props/usage
  • CSS design tokens — all --fd-* custom properties and key utility classes
  • Environment variablesVITE_FLIGHTDECK_LOCAL_API_TOKEN and VITE_DEV_PROXY_TARGET
  • Adding a new page — step-by-step guide

web/README.md (updated)

  • Removed the stale "PR split (subagent-friendly)" section that described future work (React Router, richer diff, PR B/C) which has since shipped
  • Added an App architecture section with the route/component table, shell+context data-flow summary, and a pointer to docs/web-ui.md

Codepaths covered

web/src/App.tsx, web/src/components/AppShell.tsx, web/src/context/TimelineRefreshContext.tsx, web/src/api.ts, web/src/pages/OverviewPage.tsx, web/src/pages/DiffPage.tsx, web/src/pages/ActionsPage.tsx, web/src/components/Badge.tsx, web/src/components/JsonPanel.tsx, web/src/index.css

Key knowledge gaps addressed

  • No documentation existed for the React app architecture, routing strategy, or how mutations in ActionsPage trigger automatic refreshes in OverviewPage
  • web/README.md contained forward-looking PR-split notes that were stale and potentially confusing for new contributors
Open in Web View Automation 

…ure section

- Add docs/web-ui.md: full reference for the React app that shipped in PR #17
  (HashRouter routing, OverviewPage/DiffPage/ActionsPage, TimelineRefreshContext
  data-flow, api.ts helpers, shared components, CSS design tokens, env vars,
  and a guide for adding new pages).
- Update web/README.md: remove stale PR-split section describing work that has
  already landed; replace with an App architecture summary table and a pointer
  to the new reference doc.

Co-authored-by: Gottam Sai Bharath <Gsbreddy@users.noreply.github.com>
@Gsbreddy Gsbreddy marked this pull request as ready for review May 2, 2026 11:27
@Gsbreddy Gsbreddy merged commit 6d2ef53 into main May 2, 2026
2 checks passed
@Gsbreddy Gsbreddy deleted the cursor/codebase-documentation-alignment-ca72 branch May 2, 2026 11:27
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