docs: add web UI guide and update contributor docs for shipped UI#19
Closed
cursor[bot] wants to merge 3 commits into
Closed
docs: add web UI guide and update contributor docs for shipped UI#19cursor[bot] wants to merge 3 commits into
cursor[bot] wants to merge 3 commits into
Conversation
Co-authored-by: Gottam Sai Bharath <Gsbreddy@users.noreply.github.com>
…to fix/pr9-policy-and-followups
- Add docs/web-ui.md: user-facing reference for the three-page browser UI shipped in PR #17 (Overview, Diff, Promote/Rollback). Covers navigation, per-page usage, authentication tiers, dev mode, and a common-issues table. - Add docs/web-ui.md to README.md documentation index. - Replace stale 'PR split (subagent-friendly)' planning section in web/README.md with an Architecture table that reflects the current file structure (AppShell, pages/, context/, api.ts, components/). 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
3 participants
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
Document the three-page browser UI that shipped in PR #17 and clean up a stale planning section in
web/README.md.Why
PR #17 introduced a fully navigable web UI (Overview, Diff, Promote/Rollback pages, React Router,
TimelineRefreshContext, typed API helpers) but left no user-facing documentation explaining how to use it. Theweb/README.mdalso retained a "PR split (subagent-friendly)" planning section that described future work already merged.Changes
docs/web-ui.md(new) — user-facing reference for the browser UI:npm run dev+ Vite proxy)README.md— adddocs/web-ui.mdto the documentation index.web/README.md— replace stale "PR split (subagent-friendly)" planning section with an Architecture table reflecting the currentweb/src/file structure.Validation
uv sync --frozen --extra devuv run python -m ruff check src testsuv run python -m pytestuv run python scripts/generate_schemas.pythengit diff --exit-code schemas/(if models/schemas touched)web/source changes — static assets unchanged; no rebuild requireduv run flightdeck-quickstart-verifyuv run flightdeck --helpSchema / Storage Impact
Risk
Documentation-only. No Python, TypeScript, CSS, or schema files changed.
Notes
Covers codepaths introduced in PR #17:
web/src/App.tsx,pages/OverviewPage.tsx,pages/DiffPage.tsx,pages/ActionsPage.tsx,components/AppShell.tsx,context/TimelineRefreshContext.tsx, andapi.ts. Knowledge gaps addressed: how to open and use the UI, what each page does, how authentication works for mutations, and how to set up the Vite dev server.