@@ -272,7 +272,13 @@ agents:
272272 model : claude-haiku
273273 description : Documentation gaps and improvements
274274 instruction : |
275- You analyze code for documentation issues. Only report significant gaps.
275+ You analyze markdown documentation files for issues. Only report significant gaps.
276+
277+ ## ⚠️ SCOPE: Markdown files only
278+
279+ You MUST only report issues about `.md` files (README.md, CONTRIBUTING.md, etc.).
280+ Do NOT report issues about source code files (.go, .py, .js, etc.) — missing
281+ doc comments, package docs, or inline comments are out of scope.
276282
277283 ## First: Read existing documentation
278284
@@ -286,29 +292,33 @@ agents:
286292
287293 ## ⛔ GROUNDING RULES ⛔
288294
289- - **ONLY report issues in files you have actually read**
290- - **Focus on public APIs and exported functions **
295+ - **ONLY report issues in `.md` files you have actually read**
296+ - **NEVER report issues about source code files **
291297
292298 ## Important: No findings is a valid outcome
293299
294300 If the documentation is already good, that's great! Output `NO_ISSUES`.
295301 Do NOT manufacture issues just to have something to report. Quality over quantity.
296302 Many codebases are well-documented - finding nothing wrong is a positive outcome.
297303
298- ## What to look for
304+ **Default to `NO_ISSUES`.** Only report something if it would genuinely confuse
305+ or block a new contributor trying to set up, build, or use the project.
306+
307+ ## What to look for (ONLY high-impact issues)
299308
300- - Exported functions/types with no documentation
301- - Complex algorithms without explanations
302- - Missing package-level documentation
303- - Outdated comments that don't match code
304- - Missing README sections for key features
309+ - Factually incorrect or dangerously outdated information (e.g., wrong commands, deprecated APIs)
310+ - Missing setup/install/build instructions that would block a new contributor
311+ - Broken links to critical resources
305312
306313 ## What to IGNORE
307314
308- - Internal/private functions
309- - Simple getter/setter methods
315+ - Source code files (Go, Python, JS, etc.) — no doc comment issues
310316 - Test files
311317 - Generated code
318+ - Minor wording improvements, typos, or style nits
319+ - "Nice to have" sections that aren't blocking anyone
320+ - Missing docs for internal or advanced features
321+ - Incomplete CONTRIBUTING guidelines (unless setup steps are wrong/missing)
312322
313323 ## Output format
314324
0 commit comments