docs: document v1.0.3 changes — ingest edge cases, multi-provider diff, structured action outcome#29
Closed
cursor[bot] wants to merge 1 commit into
Closed
Conversation
…f, structured action outcome - docs/cli.md: add edge-case table for 'runs ingest' (empty file exits 0, malformed JSONL exits 1, JSON array auto-detected by leading '['); update description of JSON array format detection. - docs/operations-and-policy.md: add 'Multi-provider and cross-model diffs' subsection explaining that baseline and candidate are costed independently from their own pricing_reference, that pricing_or_model_changed surfaces in CLI output / HTTP response / web UI callout, and that the cost delta should be read with caution when the flag is set. - docs/web-ui.md: document the structured outcome card added to ActionsPage in v1.0.3 (policy badge, pointer badge, metric tiles for action/release/ baseline/reason, fallback to raw JsonPanel); document the pricing/model-change fd-alert--warn callout added to DiffPage; add PolicyResultPayload and ActionOutcomePayload TypeScript types to the api.ts types section. 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
Documentation updates to align with v1.0.3 code changes that lacked matching docs coverage.
Why
The v1.0.3 release added three new behavioral features —
runs ingestedge-case handling, multi-provider/cross-model diff support, and a structured outcome card in the web UIActionsPage— but the docs were not updated to reflect them.Changes
docs/cli.mdruns ingest: empty file exits 0 withInserted 0 events; malformed JSONL exits 1; JSON array format is auto-detected by a leading[.docs/operations-and-policy.mdMulti-provider and cross-model diffssubsection undercompute_diffexplaining that baseline and candidate are priced independently from their ownspec.pricing_reference, whenpricing_or_model_changedis set, and where it surfaces (CLI note, HTTPpricing.pricing_or_model_changed, web UI warning callout).docs/web-ui.mdActionsPage(policy badge, pointer badge, metric tiles, policy failure reasons, raw JSON fallback viaJsonPanel).fd-alert--warncallout added toDiffPage.PolicyResultPayloadandActionOutcomePayloadTypeScript types to theapi.tstypes reference section.Validation
uv sync --frozen --extra devuv run python -m ruff check src tests— cleanuv run python -m pytest— 93 passedschemas/untouched)web/source changes (docs-only PR)Schema / Storage Impact
Risk
Docs-only change. No code paths altered.
Review