docs(web): add web-ui.md reference and update web/README.md#21
Merged
Conversation
…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>
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.
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:
App → AppShell → TimelineRefreshProvider → pagesTimelineRefreshContext— explains thegenerationcounter pattern, when to callnotifyTimelineMutated(), and the end-to-end data flow for post-mutation timeline refreshOverviewPage,DiffPage,ActionsPage: fields, defaults, state management, error handling, auth behaviorapi.tshelpers —fetchJson<T>auth injection / error extraction,loadTimeline()parallel fan-out, all exported TypeScript typesBadgeandJsonPanelprops/usage--fd-*custom properties and key utility classesVITE_FLIGHTDECK_LOCAL_API_TOKENandVITE_DEV_PROXY_TARGETweb/README.md(updated)docs/web-ui.mdCodepaths 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.cssKey knowledge gaps addressed
ActionsPagetrigger automatic refreshes inOverviewPageweb/README.mdcontained forward-looking PR-split notes that were stale and potentially confusing for new contributors