One-click install
npx skills add https://github.com/brainbrewlabs/brainbrew-devkit --skill doc-review-brainbrewlabs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-review
Source: https://github.com/brainbrewlabs/brainbrew-devkit/tree/main/plugin/config/templates/docs/skills/doc-review
Command: npx skills add https://github.com/brainbrewlabs/brainbrew-devkit --skill doc-review-brainbrewlabs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Ensures repository documentation is accurate, complete, and consistent with the current codebase to prevent regressions, broken examples, and user confusion.

Core Features & Use Cases

  • Locate documentation and inline comments across markdown, rst, and source docstrings using pattern search.
  • Cross-reference docs with code by comparing documented signatures, parameters, and return types against actual implementations.
  • Validate examples and links by checking import paths, example outputs for plausibility, and referenced files for existence.
  • Produce an actionable review report that lists file, line, issue, severity, and suggested fixes for maintainers and release audits.

Quick Start

Review the repository documentation for mismatched function signatures, incorrect examples, and broken links and output a tabular markdown report of findings.

Frequently Asked Questions about doc-review

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I audit documentation accuracy against my codebase?

Cross-referencing documentation with code involves comparing documented function signatures, parameters, and return types against actual source implementations. You locate docs using pattern search, read both files, validate examples and links, and output a tabular markdown review report of findings.

Can I check markdown files for broken links and incorrect code examples?

Yes, validating examples and links checks import paths, verifies example outputs for plausibility, and confirms referenced files exist in the repository. This prevents broken examples and user confusion caused by outdated documentation.

What is the best way to verify documentation completeness after code changes?

Post-change verification involves searching source files and docs by pattern, comparing function signatures and parameters against actual implementations, and producing an actionable review report with suggested fixes for maintainers.

Does documentation review work with inline docstrings and markdown?

Documentation review works with markdown, rst files, and inline source docstrings by locating documentation across these formats using pattern search, then cross-referencing content with codebase implementations to identify mismatches.

How do I generate a structured report for a pre-release documentation audit?

Generate a pre-release audit report by reviewing documentation for mismatched function signatures, incorrect examples, and broken links, then output a tabular markdown report listing file, line, issue, severity, and suggested fixes.