fix(docs): match first-audit output contract#17
Conversation
Align the public first-run success state with the alpha.6 terminal summary and saved Markdown report, remove the stale alpha.5 packet cue, and retain smoke evidence plus a regression assertion. Agent-Actor: scout Agent-Run-Id: anvil-cycle-001
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (5)
📝 WalkthroughSummary by CodeRabbit
WalkthroughThe documentation now describes audit results as concise terminal summaries followed by saved Markdown reports, including default and explicit output paths. Proof-packet guidance is pinned to ChangesAudit output documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs-site/src/content/docs/guides/first-user-proof-packet.md`:
- Line 22: Enforce the alpha.6 proof-version contract across all affected sites:
in docs-site/src/content/docs/guides/first-user-proof-packet.md:22, replace the
variable-version wording and command with the literal `@0.1.0-alpha.6` command;
regenerate docs-site/public/llms-full.txt:662 with that same command; and update
scripts/first-user-proof-docs.test.ts:166-170 to assert the exact alpha.6
command while rejecting <exact-version> and `@alpha`.
In `@scripts/first-user-proof-docs.test.ts`:
- Around line 166-170: Update the assertions in the first-user proof packet test
to require the literal command reference `@0.1.0-alpha.6`, rather than only
checking its descriptive sentence. Add negative assertions rejecting
@<exact-version>, floating `@alpha`, and variable-version examples so the public
proof workflow remains pinned to the exact published CLI version.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 94fd0564-7193-4479-9bcc-78b6c5a14485
📒 Files selected for processing (5)
docs-site/public/llms-full.txtdocs-site/src/content/docs/getting-started/first-audit.mddocs-site/src/content/docs/guides/first-user-proof-packet.mddocs/proofs/internal/2026-07-19-sfd-271-doc-output-contract.mdscripts/first-user-proof-docs.test.ts
Address review feedback by making every public proof-packet command literal alpha.6 and extending the proof-lane contract to reject variable-version drift.\n\nAgent-Actor: scout\nAgent-Run-Id: anvil-cycle-001
What changed
--outputselects a pathWhy
Resolves SFD-271. The prior success text promised Markdown on stdout even though alpha.6 prints progress and scores, then writes the full report to disk.
Verification
bun run lintbun run format:checkbun run typecheckbun testnpm run buildindocs-sitedocs/proofs/internal/2026-07-19-sfd-271-doc-output-contract.md