feat: add docs-review skill for documentation staleness detection - #717
Conversation
Add a new docs-review skill to the review agent that detects stale documentation caused by code changes. The skill builds an identifier checklist from every changed file, greps documentation for matches, and evaluates candidates in two passes (quick scan then deep read). Changes: - Create skills/docs-review/SKILL.md with 6-step process - Add docs-review to review harness and agent definition - Add documentation currency as 7th review dimension - Update pr-review to delegate to docs-review after code-review Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Review: #717Head SHA: ce183f5 SummaryThis PR cleanly adds a new FindingsCriticalNone. HighNone. Medium
Low / InfoNone. FooterOutcome: comment-only Previous runReview: #717Head SHA: b27626b SummaryThis PR cleanly adds a docs-review skill as a 7th review dimension, with well-designed integration into the review agent, harness config, and pr-review orchestration. The new skill follows established patterns (frontmatter, numbered process, constraints), includes sensible false-positive safeguards (two-pass evaluation, severity cap at high, exclusion of already-modified docs and changelogs), and all cross-references and step renumbering in pr-review are correct. No security, correctness, or injection concerns were found. FindingsLow
FooterOutcome: approve Previous run (2)Review: #717Head SHA: e4633fa SummaryThis PR cleanly adds a new FindingsMedium
Info
FooterOutcome: comment-only Previous run (3)Review: #717Head SHA: 87e4dac SummaryThe PR adds a well-structured docs-review skill with a clear six-step process (identifier extraction, doc discovery, grep, two-pass evaluation, findings) and integrates it correctly into the review agent definition, harness, and pr-review orchestration skill. The skill routing, dimension numbering, step renumbering, and finding aggregation across steps are all consistent. One medium finding: the pr-review constraint section now requires docs-review completion before posting, but step 4 defines skip conditions where docs-review is intentionally not run — these two instructions contradict each other and could cause the agent to emit a spurious failure or ignore the constraint. FindingsCritical(none) High(none) Medium
Low(none) Info(none) FooterOutcome: comment-only |
Remove the skip conditions for docs-review (docs-only PRs, reverts, >200 files) since they contradicted the constraint requiring docs-review completion before posting. The skill handles edge cases internally — no docs found produces zero findings. Addresses review feedback from fullsend-ai-review. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Remove specific directory names from step 3 exclusion instruction - Update agent description to include documentation currency Addresses review feedback from fullsend-ai-review. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Site previewPreview: https://e2875b14-site.fullsend-ai.workers.dev Commit: |
Encourage the agent to dispatch a subagent for the docs-review process to avoid consuming the main review context window. Follows the pattern established by the retro-analysis skill. Addresses review feedback from ralphbean. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
fullsend review is working on this — view logs |
Addresses review feedback from fullsend-ai-review. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
fullsend review is working on this — view logs |
ralphbean
left a comment
There was a problem hiding this comment.
LGTM. Two notes inline, both deferred to followup issues.
| complete all six dimensions (tool failure, missing context, ambiguous | ||
| findings), produce a failure result (see step 5) rather than posting | ||
| complete all seven dimensions (tool failure, missing context, ambiguous | ||
| findings), produce a failure result (see step 6) rather than posting |
There was a problem hiding this comment.
[important] "Seven dimensions" conflates pr-review orchestration steps with code-review's dimension framework. code-review owns dimensions 1–6; docs-review is a separate skill invocation, not a 7th dimension within code-review. Works today, but couples the two skills' internals.
Deferred to #943.
| - **Line:** line number of the stale reference, if identifiable. | ||
| - **Description:** what is stale and why — reference the specific code | ||
| change that caused the staleness. | ||
| - **Remediation:** what should be updated in the doc. |
There was a problem hiding this comment.
[moderate] This schema is missing the actionable field that code-review findings include. When pr-review merges findings from both skills, the mismatch may cause inconsistent output.
Deferred to #944.
Add a new docs-review skill to the review agent that detects stale documentation caused by code changes. The skill builds an identifier checklist from every changed file, greps documentation for matches, and evaluates candidates in two passes (quick scan then deep read).
Changes: