docs: align public drift capability claims - #26
Conversation
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
|
Warning Review limit reachedYou’ve reached a temporary PR review limit under our Fair Usage Limits Policy. Next review available in: 47 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the 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 configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (4)
📝 WalkthroughSummary by CodeRabbit
WalkthroughThe 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. ChangesDrift documentation alignment
Estimated code review effort: 2 (Simple) | ~10 minutes 🚥 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: 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
📒 Files selected for processing (7)
docs-site/public/llms-full.txtdocs-site/public/llms.txtdocs-site/src/content/docs/guides/drift-detection.mddocs-site/src/content/docs/index.mdxdocs-site/src/content/docs/reference/cli.mdscripts/docs-reality-contract.test.tsscripts/docs-reality-contract.ts
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
|
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. |
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