review-rust-docs

Audit Rust crate documentation by running this Skill against your crate directory to systematically check docs conformance against rust-docs-guidelines. It produces a prioritized report identifying non-conforming sections with explanations and concrete improvement suggestions for each gap found.

A Rust documentation audit identifies missing or incomplete doc comments, inconsistent formatting, undocumented public APIs, and sections that diverge from rust-docs-guidelines standards. The Skill reports each non-conformance with specific guidance on how to fix it.

Run a documentation audit before each release to verify that all crate docs align with rust-docs-guidelines. This catches gaps early, ensures consistent quality across modules, and prevents documentation debt from shipping with new versions.

Yes, this Skill targets both Rust crates and modules within them. Run it against your crate source or cargo-generated docs directory to audit the entire documentation structure and identify non-conformances at any level.

The audit report provides concrete improvement suggestions for each non-conforming location. Prioritize by severity, apply the suggested fixes to doc comments and markdown files, then re-run the audit to verify conformance before committing changes.

No setup required—the Skill reads established rust-docs-guidelines automatically. Simply point it at your crate directory and it generates a structured audit report against those standards without additional configuration.