What problem does it solve?
Discrepancies between code and documentation lead to confusion, errors, and wasted development time. This Skill automates the verification process, ensuring your documentation accurately reflects the current codebase and preventing outdated or misleading information.
Core Features & Use Cases
- Documentation-Code Consistency: Verifies that
README.md and other documentation files (docs/*.md) accurately reflect the implemented code.
- Feature Coverage Check: Ensures all implemented features are documented and that documented features are actually implemented, preventing gaps in your project's knowledge base.
- Link Validation: Checks the validity of internal links within documentation, ensuring navigability and correctness.
- Use Case: After completing a new feature or refactoring existing code, run this Skill to automatically identify any inconsistencies between your code and its corresponding documentation, ensuring your project's narrative is always up-to-date.
Quick Start
Run the code-reviewer skill to check consistency between documentation and recently changed Go files.