docs: align web-ui, cli, sdk-integrations, and ops-policy with shipped features#57
Draft
cursor[bot] wants to merge 1 commit into
Draft
docs: align web-ui, cli, sdk-integrations, and ops-policy with shipped features#57cursor[bot] wants to merge 1 commit into
cursor[bot] wants to merge 1 commit into
Conversation
…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>
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.
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)DiffVerdictStack,DiffReleaseTwin,DiffPolicyPanel,DiffChangeImpact+DiffPricingExpand,DiffDecisionCard,diffPayload.tsxshared utilities) and the verdict-first layout.DiffPage(baseline,candidate,window,environment),OverviewPage(?release=),RunsPage,ActionsPage— all now documented with examples.OverviewPagesection rewritten: documentsReleaseLifecycleStrip, the focused-release hero (triggered by?release=), the releases table filter row, copy buttons, "Live vs Registered" status badges, collapsible metrics panel.CopyTextButton(props, behavior) andReleaseLifecycleStrip(step links, read-only mode).urlSearch.tshelpers section added with deep-link examples for every page.docs/cli.mdflightdeck pricing checksubcommand (--max-age-days,--fail) with example output and CI usage pattern. Covers the stale-bundled-snapshot detection workflow.docs/pricing-catalog.mdcli.md § flightdeck pricing checkreference.docs/operations-and-policy.mdpromotion_requeststable for approval workflow).promotion_requests).docs/sdk-integrations.mdcommon.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.tsxandweb/src/components/diff/web/src/pages/OverviewPage.tsxweb/src/components/CopyTextButton.tsx,ReleaseLifecycleStrip.tsxweb/src/urlSearch.tssrc/flightdeck/cli/main.py(pricing_checkcommand)src/flightdeck/storage.py(migration v4 —promotion_requests)src/flightdeck/integrations/(all submodules)Key knowledge gaps addressed