codebase-audit-writer
CommunityAutomate crate analysis to generate docs.
AuthorRyderFreeman4Logos
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This tool automates deep crate analysis to produce four outputs: facts.toml, README.md, review_report.md, and blog.md, enabling consistent documentation and governance of crates.
Core Features & Use Cases
- Automated crate analysis to extract APIs, architecture overview, and quality signals.
- Generate machine-readable metadata (facts.toml) and human-facing documentation (README.md, review_report.md, blog.md) from a single source of truth.
- Use Case: Audit a Rust crate to publish a documentation package for developers and managers.
Quick Start
Run the codebase-audit-writer against a crate directory to generate the four output artifacts.
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: codebase-audit-writer Download link: https://github.com/RyderFreeman4Logos/cli-sub-agent/archive/main.zip#codebase-audit-writer Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 510,000+ vetted skills library on demand.