Skip to content

docs(web-ui): document SecurityStatusBar, uiConfig, and read-only UI mode from v1.0.2#24

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

docs(web-ui): document SecurityStatusBar, uiConfig, and read-only UI mode from v1.0.2#24
Gsbreddy merged 1 commit into
mainfrom
cursor/codebase-documentation-alignment-8815

Conversation

@cursor
Copy link
Copy Markdown

@cursor cursor Bot commented May 2, 2026

What changed

Updated docs/web-ui.md to cover the UI subsystems introduced in v1.0.2 that were not yet documented.

Docs updated

docs/web-ui.md — +72 lines / -11 lines

Codepaths covered

New source Added doc
web/src/uiConfig.ts New uiConfig.ts section: UI_READ_ONLY boolean and clientMutationTokenConfigured() helper
web/src/components/SecurityStatusBar.tsx New SecurityStatusBar section: all render conditions (read-only banner, fetch error, bearer mismatch, normal auth info)
web/src/App.tsx UI_READ_ONLY redirect Routing table Notes column; #/actions redirect behavior explained
web/src/components/AppShell.tsx AppShell section: SecurityStatusBar mount point; Promote nav suppression
web/src/api.tsHealthPayload, fetchHealth() api.ts section: new type + helper documented
web/src/index.cssfd-alert--info/warn, fd-security-strip* CSS table: new modifier and class entries

Key knowledge gaps addressed

  • VITE_FLIGHTDECK_UI_READ_ONLY was not documented anywhere in docs/; only referenced in web/README.md. Now fully explained including the routing redirect, nav suppression, and SecurityStatusBar banner.
  • SecurityStatusBar (new in v1.0.2) had zero coverage in docs/web-ui.md. All five render conditions documented including the token mismatch warning.
  • HealthPayload type and fetchHealth() helper (new in v1.0.2) were absent from the api.ts section.
  • Whitespace-only token handling (server and client both strip whitespace before treating token as set) is now explicit.
  • Component tree diagram updated to show SecurityStatusBar position.

No behavior was fabricated; all additions verified against source files.

Open in Web View Automation 

…mode from v1.0.2

- Routing table: add Notes column; document VITE_FLIGHTDECK_UI_READ_ONLY redirect behavior for #/actions
- Component tree: add SecurityStatusBar to the diagram; note UI_READ_ONLY redirect
- AppShell section: mention SecurityStatusBar mount point and Promote nav suppression
- New uiConfig.ts section: UI_READ_ONLY boolean and clientMutationTokenConfigured() helper
- New SecurityStatusBar section: all render conditions (read-only, fetch error, bearer mismatch, normal)
- api.ts section: add HealthPayload type and fetchHealth() helper used by SecurityStatusBar
- CSS table: expand fd-alert modifiers (--info, --warn); add fd-security-strip and fd-security-strip__msg
- Environment variables table: add VITE_FLIGHTDECK_UI_READ_ONLY; expand token note with whitespace-trim behavior

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