Skip to content

docs: add pricing check command, OverviewPage hero/filters, and UI deep-link reference#58

Draft
cursor[bot] wants to merge 1 commit into
mainfrom
cursor/technical-documentation-updates-809f
Draft

docs: add pricing check command, OverviewPage hero/filters, and UI deep-link reference#58
cursor[bot] wants to merge 1 commit into
mainfrom
cursor/technical-documentation-updates-809f

Conversation

@cursor
Copy link
Copy Markdown

@cursor cursor Bot commented May 18, 2026

Summary

Documentation-only PR. Updates two doc files to cover recently shipped features that had no written documentation.

Why

Several features shipped in v1.2.0 and adjacent PRs (pricing staleness tooling, OverviewPage focused-release hero, URL deep-linking, ReleaseLifecycleStrip, CopyTextButton) were undocumented or only partially referenced. This PR fills those gaps without inventing behavior — everything is verified against the source code.

Changes

docs/cli.md

  • Add flightdeck pricing check command section: --max-age-days (default 90), --fail flag, output format (OK / STALE), and CI use note. Links back to pricing-catalog.md staleness guardrails.

docs/web-ui.md

  • Update routing table: add URL search param annotations for every page (#/?release=<id>, #/diff?baseline=…&candidate=…&window=…&environment=…, #/runs?release_id=…, #/actions?release_id=…); add deep-link explanation paragraph that calls out shortcut link generation in the releases table and the focused-release hero.
  • Rewrite OverviewPage section: document the focused-release hero (?release=<id> URL param, hero content, action buttons, unknown-ID warning), release table client-side filters (agent / env / promotion status), and the collapsible ledger metrics panel.
  • Add urlSearch.ts section: documents pickTrimmedSearch and searchParamsFromRecord with usage pattern.
  • Add CopyTextButton to shared components: props table, clipboard fallback behavior, and usage context.
  • Add ReleaseLifecycleStrip to shared components: step table, UI_READ_ONLY behavior, no-API-call note.
  • Extend CSS utility class table: fd-lifecycle-strip, fd-release-hero, fd-copy-btn, fd-card--collapse, fd-collapse-head, fd-collapse-body, fd-filter-row, fd-table-toolbar, fd-table-actions, fd-cell-stack, fd-cell-inline.

Validation

  • uv run python -m ruff check src tests — all checks passed
  • uv run python -m pytest — 139 passed, 4 skipped
  • uv run python scripts/generate_schemas.py then git diff --exit-code schemas/ — clean (no schema changes)
  • No web/ source changes; no static bundle rebuild needed

Schema / Storage Impact

  • None

Risk

Documentation only. No code, schema, or bundle changes.

Notes

Codepaths covered: src/flightdeck/cli/main.py (pricing check command), src/flightdeck/bundled_pricing_age.py, web/src/pages/OverviewPage.tsx, web/src/components/ReleaseLifecycleStrip.tsx, web/src/components/CopyTextButton.tsx, web/src/urlSearch.ts.

Open in Web View Automation 

…ep-link reference

- docs/cli.md: add flightdeck pricing check section (--max-age-days, --fail, output
  format, CI use note); links back to pricing-catalog.md staleness guardrails
- docs/web-ui.md: update routing table with URL search params for all pages
  (#/ ?release=, #/diff ?baseline/candidate/window/environment, #/runs ?release_id,
  #/actions ?release_id/environment/window); add deep-link explanation paragraph
- docs/web-ui.md: rewrite OverviewPage section to document focused-release hero,
  release table client-side filters, collapsible ledger metrics panel, ReleaseLifecycleStrip
- docs/web-ui.md: add urlSearch.ts section (pickTrimmedSearch, searchParamsFromRecord)
- docs/web-ui.md: add CopyTextButton and ReleaseLifecycleStrip to shared components
- docs/web-ui.md: add new CSS utility classes to token table (fd-lifecycle-strip,
  fd-release-hero, fd-copy-btn, fd-card--collapse, fd-collapse-head, fd-filter-row,
  fd-table-toolbar, fd-table-actions, fd-cell-stack, fd-cell-inline)

Co-authored-by: Gottam Sai Bharath <Gsbreddy@users.noreply.github.com>
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