skills.rest
RyderFreeman4Logos
RyderFreeman4LogosCOMMUNITY
Explore all skills by this author →
𝕏@wuzhige4pixelGitHub

codebase-audit-writer

Analyze Rust crates to generate facts.toml, README.md, review_report.md, and blog.md.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about codebase-audit-writer

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

FAQPage Schema
How do I automate crate analysis to generate documentation from a Rust codebase?▼

Automate crate analysis by parsing source files to extract APIs and constraints, generating machine-readable metadata and human-facing documentation. This produces four artifacts: facts.toml, README.md, review_report.md, and blog.md.

What is the best way to audit a Rust crate for architecture and quality signals?▼

Auditing a Rust crate involves deep analysis of the codebase to extract APIs, architecture overviews, and quality signals. The process outputs a review_report.md and machine-readable facts.toml for governance.

Can I generate machine-readable metadata and a README from a multi-module Rust project?▼

Yes, crate analysis applies to individual crates of varying sizes, including multi-module projects. It extracts APIs and constraints to generate a facts.toml metadata file and a README.md from a single source of truth.

How do I create a blog post and review report directly from my Rust source files?▼

Generate a blog post and review report by automating deep crate analysis on your source files. The process extracts architecture and quality signals, outputting blog.md and review_report.md for developers and managers.

Does automated crate analysis work for crates of varying sizes?▼

Yes, automated crate analysis applies to individual crates of varying sizes, including multi-module projects. It parses source files to extract APIs and constraints for documentation generation.

Why do I need a facts.toml file when documenting my Rust crate?▼

A facts.toml file provides machine-readable metadata extracted from your crate source files. It acts as a single source of truth alongside human-facing README.md, review_report.md, and blog.md documentation artifacts.

Related Skills

Explore More Software Engineering Skills→
VMRam95VMRam95

agentlens

Analyze directory structures and source code to generate hierarchical documentation and architectural maps.

Community
Intermediate
zxpmailzxpmail
18

release-builder

Automate build, test, and publish lifecycle for web, desktop, and CLI applications.

Community
Advanced
JaviMontanoJaviMontano

apex-risk-monitoring

Aggregate schedule, budget, sentiment, and event signals into a real-time risk dashboard.

Community
Advanced
StarttiStartti

documentation

Update repository documentation from git diffs and validate Rustdoc and Python docstrings.

Official
Intermediate