codebase-audit-reviewer

Audit README.md, docs, and facts.toml against source code for accuracy.

12|1|Updated Feb 6, 2026
One-click install
npx skills add https://github.com/RyderFreeman4Logos/cli-sub-agent --skill codebase-audit-reviewer
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: codebase-audit-reviewer
Source: https://github.com/RyderFreeman4Logos/cli-sub-agent/tree/main/patterns/codebase-audit/skills/codebase-audit-reviewer
Command: npx skills add https://github.com/RyderFreeman4Logos/cli-sub-agent --skill codebase-audit-reviewer

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Fact-checking Writer CSA outputs against the actual source code to ensure documentation accuracy and alignment with code behavior, reducing mismatches and manual rework.

Core Features & Use Cases

  • Verifies that READMEs, blog posts, and code-derived docs reflect the current source code by validating references to functions, types, and modules.
  • Performs source-verification, consistency checks, and completeness audits across single-crate and multi-crate projects, from draft documentation to release notes.
  • Produces actionable corrections and in-place fixes to doc claims, enabling rapid quality assurance of the codebase documentation.

Quick Start

Run the codebase-audit-reviewer skill in executor mode by including <skill-mode>executor</skill-mode> in your prompt to start auditing the codebase.

Frequently Asked Questions about codebase-audit-reviewer

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

FAQPage Schema
How do I fact-check documentation against actual source code?

To fact-check documentation against source code, audit README.md, docs, and facts.toml entries by inspecting source files, function signatures, and public APIs. This skill enforces source-verification and consistency checks to output precise corrections for in-place fixes.

What is the best way to audit codebase documentation for multi-crate projects?

Auditing codebase documentation for multi-crate projects requires consistency and completeness checks across all crates. This skill verifies references to functions, types, and modules across single-crate and multi-crate projects, producing actionable corrections for doc claims during drafting or post-release reviews.

Can I verify README accuracy by inspecting function signatures and type definitions?

Yes, you can verify README accuracy by inspecting function signatures and type definitions. This skill validates references to functions, types, and modules in READMEs and code-derived docs to ensure they reflect the current source code behavior and reduce mismatches.

How do I start a codebase audit in executor mode?

To start a codebase audit in executor mode, include the executor skill-mode tag in your prompt. This initiates the source-verification process to audit codebase documentation and generate actionable corrections for in-place fixes.

Why does code-derived documentation mismatch the current source code?

Code-derived documentation mismatches current source code when references to functions, types, and modules are not updated during drafting or post-release. This skill performs completeness audits and consistency checks to identify and correct these documentation mismatches.

Do I need a facts.toml file to perform a codebase documentation audit?

A facts.toml file is one of the entries this skill audits for alignment with the source code. While it focuses on verifying README.md, docs, and facts.toml entries, the core requirement is having source files and documentation outputs ready for source-verification and consistency checks.