Skip to content

fix(docs): match first-audit output contract#17

Merged
jaruesink merged 2 commits into
mainfrom
fix/sfd-271-first-audit-output-contract
Jul 19, 2026
Merged

fix(docs): match first-audit output contract#17
jaruesink merged 2 commits into
mainfrom
fix/sfd-271-first-audit-output-contract

Conversation

@jaruesink

Copy link
Copy Markdown
Contributor

What changed

  • describe the real first-run terminal summary plus saved Markdown report
  • name the default report path and clarify that --output selects a path
  • remove the stale unqualified alpha.5 proof-packet cue
  • retain a current alpha.6 smoke packet and add a docs contract assertion

Why

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 lint
  • bun run format:check
  • bun run typecheck
  • bun test
  • npm run build in docs-site
  • rendered-page text checks for both affected pages
  • pinned alpha.6 smoke run retained in docs/proofs/internal/2026-07-19-sfd-271-doc-output-contract.md

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
@coderabbitai

coderabbitai Bot commented Jul 19, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 98a16c85-cda0-4494-bc8b-8214a20fd4e0

📥 Commits

Reviewing files that changed from the base of the PR and between 0b369de and 4d500cc.

📒 Files selected for processing (5)
  • docs-site/public/llms-full.txt
  • docs-site/src/content/docs/guides/first-user-proof-packet.md
  • scripts/first-user-proof-docs.test.ts
  • scripts/proof-lane-contract.ts
  • scripts/verify-proof-lane-docs.ts

📝 Walkthrough

Summary by CodeRabbit

  • Documentation

    • Updated first-audit guidance to reflect terminal progress, then a concise score summary, followed by a “Audit report written: ” message.
    • Clarified default report location (docs/audits/<repo>-audit-<date>.md) and how --output controls the save path (including relative paths from the current working directory).
    • Hard-pinned the first-user proof packet walkthrough to 0.1.0-alpha.6 and aligned the related --version cross-check examples.
    • Replaced older success/output samples with a new “Example terminal finish” snippet.
  • Tests

    • Strengthened automated checks for the updated success text, report-path expectations, and pinned proof-packet command layouts.

Walkthrough

The 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 0.1.0-alpha.6, with an internal contract record and automated documentation assertions.

Changes

Audit output documentation

Layer / File(s) Summary
Document saved report flow
docs-site/src/content/docs/getting-started/first-audit.md, docs-site/public/llms-full.txt
First-audit guidance now documents terminal score summaries, Audit report written: <path>, default report locations, --output path selection, and AI-backed report priorities.
Pin proof packet and record output contract
docs-site/src/content/docs/guides/first-user-proof-packet.md, docs-site/public/llms-full.txt, docs/proofs/internal/2026-07-19-sfd-271-doc-output-contract.md
Proof-packet instructions use the pinned 0.1.0-alpha.6 repo-root command, while the internal contract records the observed saved-report behavior.
Validate public documentation wording
scripts/proof-lane-contract.ts, scripts/verify-proof-lane-docs.ts, scripts/first-user-proof-docs.test.ts
Exported command contracts, verification expectations, and tests enforce pinned commands, saved-report wording, default path guidance, and the absence of stdout-oriented descriptions.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title is concise and accurately summarizes the docs change to the first-audit output contract.
Description check ✅ Passed The description covers what changed, why, and verification, but it does not follow the template exactly and omits the review checklist section.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/sfd-271-first-audit-output-contract

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5679390 and 0b369de.

📒 Files selected for processing (5)
  • docs-site/public/llms-full.txt
  • docs-site/src/content/docs/getting-started/first-audit.md
  • docs-site/src/content/docs/guides/first-user-proof-packet.md
  • docs/proofs/internal/2026-07-19-sfd-271-doc-output-contract.md
  • scripts/first-user-proof-docs.test.ts

Comment thread docs-site/src/content/docs/guides/first-user-proof-packet.md Outdated
Comment thread scripts/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
@jaruesink
jaruesink merged commit 5eb3551 into main Jul 19, 2026
3 checks passed
@jaruesink
jaruesink deleted the fix/sfd-271-first-audit-output-contract branch July 19, 2026 17:22
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