Skip to content

docs: align public drift capability claims - #26

Merged
jaruesink merged 4 commits into
mainfrom
feat/sfd-335-public-docs-parity
Aug 3, 2026
Merged

docs: align public drift capability claims#26
jaruesink merged 4 commits into
mainfrom
feat/sfd-335-public-docs-parity

Conversation

@jaruesink

Copy link
Copy Markdown
Contributor

Summary\n\nAlign the homepage, Drift Detection guide, CLI reference, and generated agent docs with shipped path, glob, date, broken-symlink, and command checks. Keep coverage analysis explicitly planned. Extend the docs-reality guard to public docs and assert exact stale source lines.\n\n## Verification\n\n- lint\n- format:check\n- typecheck\n- bun test (357 passed)\n- docs-site build\n- desktop and iPhone 14 render checks via Agent Browser\n\nCloses SFD-335

Extend the docs reality contract to cover public docs-site claims and report exact stale source lines. Refresh generated agent docs with the shipped path, glob, date, symlink, and command checks while leaving coverage analysis planned.

Agent-Actor: scout

Agent-Run-Id: anvil-cycle-001
@coderabbitai

coderabbitai Bot commented Aug 3, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

You’ve reached a temporary PR review limit under our Fair Usage Limits Policy.

Your recent review volume is higher than typical usage, so adaptive limits are currently applied.

Next review available in: 47 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 5ac28dee-4999-40de-81d4-6bd7a9d692d3

📥 Commits

Reviewing files that changed from the base of the PR and between be0a791 and f213826.

📒 Files selected for processing (4)
  • docs-site/public/llms-full.txt
  • docs-site/src/content/docs/guides/drift-detection.md
  • scripts/docs-reality-contract.test.ts
  • scripts/docs-reality-contract.ts
📝 Walkthrough

Summary by CodeRabbit

  • Documentation

    • Updated drift detection documentation to clarify supported checks for stale paths, broken globs, outdated validation dates, broken symlinks, and command availability.
    • Clarified that coverage gap analysis remains planned.
    • Refined remediation guidance and updated guardrail terminology and documentation dates.
  • Tests

    • Added coverage to verify documentation drift claims are detected accurately, including reported file locations and source lines.

Walkthrough

The documentation now describes path, glob, validation-date, broken-symlink, and command checks as implemented. Coverage analysis remains planned. Documentation claim checks and tests detect stale drift-status statements.

Changes

Drift documentation alignment

Layer / File(s) Summary
Documentation claim contracts
scripts/docs-reality-contract.ts, scripts/docs-reality-contract.test.ts
Added patterns for stale drift claims and tests for file, line, and claim reporting.
Source drift documentation
docs-site/src/content/docs/index.mdx, docs-site/src/content/docs/guides/drift-detection.md, docs-site/src/content/docs/reference/cli.md, docs-site/public/llms.txt
Updated drift descriptions, issue types, remediation guidance, and planned coverage-analysis status.
Generated documentation refresh
docs-site/public/llms-full.txt
Updated generated documentation for drift checks, planned coverage analysis, readiness classification, and generation date.

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

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the primary documentation alignment change.
Description check ✅ Passed The description includes a clear summary, verification results, and the linked issue, but omits the review checklist.
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 feat/sfd-335-public-docs-parity

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: 4

🤖 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/drift-detection.md`:
- Around line 39-41: Add command availability to the Implemented today list in
docs-site/src/content/docs/guides/drift-detection.md, keep coverage analysis
under Planned with its numbering incremented, then regenerate
docs-site/public/llms-full.txt so its corresponding list mirrors the updated
source.
- Around line 39-41: Restart the ordered list under “Planned:” at item 1 by
changing the visible item numbering for “Coverage analysis” from 5 to 1;
preserve the existing list content and heading.

In `@scripts/docs-reality-contract.test.ts`:
- Around line 69-90: Update the test around findDocsRealityDriftFailures to
place the stale claim after one or more leading lines in the fixture content,
then change the expected line value to that later source line. Keep the expected
file and claim unchanged so the test specifically validates lineNumberAt’s
non-first-line behavior.

In `@scripts/docs-reality-contract.ts`:
- Around line 42-55: Update the regex patterns in the docs reality contract to
accept plural forms, hyphenated “broken-symlink” variants, and “command
availability” wording while preserving the existing stale-claim detection. Add
regression fixtures covering globs, commands, dates, broken symlinks,
broken-symlink, and command availability so these claims trigger failures.
🪄 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: fee864cb-7dfd-4323-a938-99c5dca02a55

📥 Commits

Reviewing files that changed from the base of the PR and between 460602c and be0a791.

📒 Files selected for processing (7)
  • docs-site/public/llms-full.txt
  • docs-site/public/llms.txt
  • docs-site/src/content/docs/guides/drift-detection.md
  • docs-site/src/content/docs/index.mdx
  • docs-site/src/content/docs/reference/cli.md
  • scripts/docs-reality-contract.test.ts
  • scripts/docs-reality-contract.ts

Comment thread docs-site/src/content/docs/guides/drift-detection.md Outdated
Comment thread scripts/docs-reality-contract.test.ts
Comment thread scripts/docs-reality-contract.ts
Scout added 3 commits August 3, 2026 00:40
Include command checks in the implemented public capability list and add a positive contract assertion so shipped checks cannot be omitted while coverage analysis stays planned.

Agent-Actor: scout

Agent-Run-Id: anvil-cycle-001
Incorporate CodeRabbit and Atticus review feedback by separating planned numbering, covering non-first-line claims, and testing plural, hyphenated, and command-availability stale variants.

Agent-Actor: scout

Agent-Run-Id: anvil-cycle-001
Factor the public stale-claim variants into shared fixture data so the contract test remains below the lint function-length budget.

Agent-Actor: scout

Agent-Run-Id: anvil-cycle-001
@jaruesink

Copy link
Copy Markdown
Contributor Author

Addressed CodeRabbit's actionable review feedback in commits b831e4b and f213826: command drift is listed in the implemented guide contract; coverage uses independent planned numbering; the line-number test now uses a later source line; and the public stale-claim matcher/fixtures cover plural, spaced/hyphenated broken-symlink, and command-availability variants. Final local gates pass: lint, format:check, typecheck, and 359 tests; docs-site build remains green.

@jaruesink
jaruesink merged commit 880e02b into main Aug 3, 2026
3 checks passed
@jaruesink
jaruesink deleted the feat/sfd-335-public-docs-parity branch August 3, 2026 05:44
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