docs(web-ui): document v1.0.3 UI changes — structured action outcome, pricing warning, new types and CSS classes#28
Merged
Conversation
… pricing warning, new types and CSS classes - ActionsPage: replace raw-JSON-open-by-default description with structured outcome card details (pickOutcome, policy/pointer badges, metric grid, reasons list, raw panel collapse behaviour) - DiffPage: document pricing-change warning banner (fd-alert--warn, pricing block fields, pricing_or_model_changed flag) - api.ts Types: add PolicyResultPayload and ActionOutcomePayload type listings with cross-reference to server _action_body() - CSS table: add fd-inline, fd-samples, fd-reasons utility classes 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
2 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
Update
docs/web-ui.mdto align with the v1.0.3 web UI enhancements shipped in #26. Four documentation gaps are addressed.Why
The v1.0.3 release added structured outcome rendering to
ActionsPage, a pricing-change warning toDiffPage, two new exported TypeScript types, and three new CSS utility classes. None of these were reflected indocs/web-ui.md.Changes
ActionsPagesection: rewrote the "After a successful mutation" description to document the newpickOutcome()coercion function, the structured outcome card (policy/pointer badges, metric grid for action/release/baseline IDs, policy reasons list), and the revisedJsonPanelcollapse behavior (opens by default only whenpickOutcome()returnsnull).DiffPagesection: added a bullet documenting thefd-alert--warnpricing-change banner — whenpricing_or_model_changed: truein the diff response, a warning shows baseline and candidate provider/version/model.api.tsTypes section: addedPolicyResultPayloadandActionOutcomePayloadtype listings with cross-references to the server contract in_action_body()and the 409 policy-block response shape.fd-inline,fd-samples, andfd-reasons— all present inindex.cssbut previously undocumented.Validation
Documentation-only change (no source, schema, or static bundle edits). No CI gates apply beyond normal linting.
uv sync --frozen --extra devuv run python -m ruff check src testsuv run python -m pytestgenerate_schemas.py/ schema diff — not applicable (no model changes)web/source changes)uv run flightdeck-quickstart-verifyuv run flightdeck --helpSchema / Storage Impact
Risk
Low — documentation-only PR. All descriptions were verified against current source code in
web/src/.Review
Notes
Triggered by push to
main(commit e90b2c9) following the v1.0.2 web-ui docs PR (#24). This PR captures the remaining v1.0.3 (fcd4692) UI changes that were not yet documented.