code-reviewer

Verify Go documentation-code consistency and report issues as file:line.

1|Updated Oct 31, 2025
One-click install
npx skills add https://github.com/raiich/jumpstarter --skill code-reviewer-raiich
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: code-reviewer
Source: https://github.com/raiich/jumpstarter/tree/main/.claude/skills/code-reviewer
Command: npx skills add https://github.com/raiich/jumpstarter --skill code-reviewer-raiich

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about code-reviewer

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

FAQPage Schema
How do I verify that my Go project's documentation matches the current code?

Documentation-code consistency verification automatically checks README.md and docs/*.md files against recently edited Go files to ensure features are documented, benchmarks are implemented, and internal links are valid. Run the code-reviewer Skill after completing features or refactoring to identify mismatches before they cause confusion.

Can I automate checks for outdated or missing documentation in Go projects?

Yes. This Skill automates consistency checks by comparing your codebase against documentation, verifying that implemented features are documented and documented features actually exist. It reports issues by file and line number, making it easy to locate and fix discrepancies.

What does the Skill check when validating Go project documentation?

The Skill verifies that benchmark categories in code match documentation, all new features are documented, existing documentation reflects current implementations, and internal links within docs/*.md are valid and point to accessible resources.

When should I run documentation consistency checks in my Go workflow?

Run this Skill after implementing new features or refactoring existing code to catch documentation gaps early. Regular checks prevent outdated information from misleading developers and reduce time spent debugging code-documentation mismatches.

What's the best way to maintain accurate documentation in fast-moving Go projects?

Automate consistency verification as part of your development workflow. This Skill identifies gaps between code and docs systematically, ensuring your README.md and docs/*.md stay synchronized with implementations without manual review overhead.

Does this work for Go projects with multiple documentation files?

Yes. The Skill scans README.md and all files in docs/*.md directories, verifying consistency across your entire documentation set against recently changed Go files using read, grep, and glob operations only.