Skip to content

docs: align web-ui, cli, sdk-integrations, and ops-policy with shipped features#57

Draft
cursor[bot] wants to merge 1 commit into
mainfrom
cursor/codebase-documentation-alignment-322e
Draft

docs: align web-ui, cli, sdk-integrations, and ops-policy with shipped features#57
cursor[bot] wants to merge 1 commit into
mainfrom
cursor/codebase-documentation-alignment-322e

Conversation

@cursor
Copy link
Copy Markdown

@cursor cursor Bot commented May 11, 2026

Summary

Documentation-only PR. No source code changes. Brings five doc files current with features shipped in recent releases (v1.1.x–v1.2.0).

Docs added/updated

docs/web-ui.md (largest change)

  • DiffPage section rewritten: documents the refactored component tree (DiffVerdictStack, DiffReleaseTwin, DiffPolicyPanel, DiffChangeImpact + DiffPricingExpand, DiffDecisionCard, diffPayload.tsx shared utilities) and the verdict-first layout.
  • URL deep-linking: DiffPage (baseline, candidate, window, environment), OverviewPage (?release=), RunsPage, ActionsPage — all now documented with examples.
  • OverviewPage section rewritten: documents ReleaseLifecycleStrip, the focused-release hero (triggered by ?release=), the releases table filter row, copy buttons, "Live vs Registered" status badges, collapsible metrics panel.
  • New shared components: CopyTextButton (props, behavior) and ReleaseLifecycleStrip (step links, read-only mode).
  • urlSearch.ts helpers section added with deep-link examples for every page.
  • Routing table updated: reflects current pages and their URL param behavior.
  • Component tree updated to show nested DiffPage component structure.
  • CSS utility classes table extended with 15 new entries for DiffPage and OverviewPage additions.

docs/cli.md

  • Added flightdeck pricing check subcommand (--max-age-days, --fail) with example output and CI usage pattern. Covers the stale-bundled-snapshot detection workflow.

docs/pricing-catalog.md

  • Linked the staleness guardrails paragraph to the new cli.md § flightdeck pricing check reference.

docs/operations-and-policy.md

  • Schema migration v4 added to the migrations table (promotion_requests table for approval workflow).
  • Storage schema table updated from 7 to 8 tables (added promotion_requests).

docs/sdk-integrations.md

  • New Module reference section documenting public APIs for all integration submodules: common.make_run_end_event, common.temporal_labels, openai_chat.run_event_from_openai_chat_completion, anthropic_messages.run_event_from_anthropic_message, openai_agents.run_event_from_openai_agents_result, langchain_callback.FlightDeckLangChainCallbackHandler, crewai_bridge.run_event_from_crew_token_totals.

Codepaths covered

  • web/src/pages/DiffPage.tsx and web/src/components/diff/
  • web/src/pages/OverviewPage.tsx
  • web/src/components/CopyTextButton.tsx, ReleaseLifecycleStrip.tsx
  • web/src/urlSearch.ts
  • src/flightdeck/cli/main.py (pricing_check command)
  • src/flightdeck/storage.py (migration v4 — promotion_requests)
  • src/flightdeck/integrations/ (all submodules)

Key knowledge gaps addressed

  • How to deep-link into DiffPage, OverviewPage, RunsPage, and ActionsPage from external tools or cross-page navigation
  • What each DiffPage component renders and when (verdict vs policy vs impact vs decision)
  • How to check bundled pricing snapshot freshness in CI
  • Which storage table was added for the approval workflow
  • What public function to call for each integration adapter (previously undocumented)
Open in Web View Automation 

…d features

- web-ui.md: document refactored DiffPage component tree (DiffVerdictStack,
  DiffReleaseTwin, DiffPolicyPanel, DiffChangeImpact/DiffPricingExpand,
  DiffDecisionCard, diffPayload.tsx), URL deep-linking for all pages,
  OverviewPage focused-release hero (?release= param), ReleaseLifecycleStrip,
  CopyTextButton, urlSearch.ts helpers, updated routing table, new CSS classes
  for DiffPage and OverviewPage additions

- cli.md: add flightdeck pricing check subcommand (--max-age-days, --fail)
  with example output and CI usage pattern

- pricing-catalog.md: link flightdeck pricing check reference to cli.md

- operations-and-policy.md: add schema migration v4 (promotion_requests table);
  update storage schema table from 7 to 8 tables

- sdk-integrations.md: add Module reference section documenting make_run_end_event,
  temporal_labels, and per-integration public APIs (openai_chat, anthropic_messages,
  openai_agents, langchain_callback, crewai_bridge)

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