docs-scanner: raise the bar for issue quality#24623
Open
dvdksn wants to merge 1 commit intodocker:mainfrom
Open
docs-scanner: raise the bar for issue quality#24623dvdksn wants to merge 1 commit intodocker:mainfrom
dvdksn wants to merge 1 commit intodocker:mainfrom
Conversation
Rewrites the scanner instruction to focus on substantive documentation problems rather than mechanical style violations. Key changes: - Adds a 4-question self-check gate before any issue is filed - Explicitly excludes broken links, single time-relative words, feature gates (Limited Access, Contact sales), and vague verification tasks - Replaces "max 3 per run" with "file zero if nothing substantive found" - Elevates cross-document contradiction detection as the primary focus - Adds "Why this matters" section to issue template to force impact reasoning - Adds --repo docker/docs to gh commands for correctness outside repo root Based on analysis of all agent/generated issues to date: borderline issues like docker#24266, docker#24245, docker#24310 were all single Vale-catchable words; bad issues like docker#24617, docker#24618, docker#24619 were feature-gate misidentification and vague verification tasks. Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
craig-osterhout
approved these changes
Apr 3, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The nightly docs-scanner was filing too many low-signal issues: single Vale-catchable words ("currently", "still", "yet"), feature-gate language misidentified as stale framing (#24617), and vague "verify X" tasks (#24618, #24619). This rewrites the scanner instruction to focus on substantive problems a reader would actually notice.
Changes to
.github/agents/docs-scanner.yaml:Learnings
Generated by Claude Code