Audit READMEs, API docs, and code comments against repository code.
npx skills add https://github.com/mattdurham/bob --skill docs-reviewer
Please help me install this Agent Skill. Skill: docs-reviewer Source: https://github.com/mattdurham/bob/tree/main/agents/docs-reviewer Command: npx skills add https://github.com/mattdurham/bob --skill docs-reviewer
Ensure documentation accuracy and completeness by auditing project docs against the actual codebase, identifying mismatches and gaps that mislead users.
Spawn the docs-reviewer as part of a workflow to automatically audit your repository's documentation and produce a findings report.
High-intent search queries and answers about installing and using this skill.
To audit README accuracy, spawn the docs-reviewer to review your project documentation against the actual codebase, verifying that examples match implementation and generating a findings report at bots/review-docs.md for remediation.
Validating API documentation and code comments involves auditing project docs against the codebase to identify mismatches and gaps. This process produces a formal Documentation Review Report ensuring accuracy and completeness for users.
Yes, you can automatically generate a documentation review report by spawning the docs-reviewer as part of a workflow. It audits your repository and outputs findings to bots/review-docs.md with recommended fixes.
Yes, the documentation review process validates that code examples match implementation and compile when tested. It audits READMEs, API docs, and in-code comments to ensure accuracy and completeness.
API documentation mismatches occur when docs are not audited against the codebase. Reviewing API docs and code comments identifies gaps and inaccuracies, producing a formal findings report to guide remediation.
You need a formal documentation review report when ensuring documentation accuracy and completeness across a repository. It audits READMEs, API docs, and code comments against code to identify mismatches that mislead users.
richardcbGenerate JSDoc comments, README updates, and developer guides for implemented features.
symfonyCross-check documentation references against the current codebase and report outdated ones.
arcasilesgroupRefactor existing code to improve internal structure without changing external behavior.
zero-rehqGenerate OpenAPI specs from TypeScript Express, Next.js, and Fastify source code.
