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.