About review-rust-docs
A skill for reviewing Rust crate or module documentation against the project's guidelines. It reports locations that do not conform and suggests improvements.
Key features
- 01Review documentation for Rust files
- 02Accept crate, file, or directory paths
- 03Apply project documentation guidelines
- 04Report issues with improvement suggestions
Use cases
- 01Audit Rust crate documentation
- 02Review docs across a module directory
- 03Find and improve nonconforming documentation
Install
Copy the command and run it in a terminal.
npx skills add https:/After installing, type/review-rust-docsin Claude Code to confirm it loaded.
Details
From the project READMEReview Rust Docs
Read the documentation of a Rust crate or module to ensure it meets our requirements and standards.
Arguments
<path>: Path to the Rust crate or file whose documentation needs to be reviewed.<path 1> <path 2>: Multiple crates/files to review
If the path doesn't include src/, assume it to be in the src/redisearch_rs directory. E.g. numeric_range_tree becomes src/redisearch_rs/numeric_range_tree.
If the path points to a directory, review the documentation of all Rust files in that directory.
Instructions
Read the documentation of the specific Rust files and ensure they meet the guidelines outlined in rust-docs-guidelines.
Emit a report for all non-conforming locations you find, with an explanation of why they are non-conforming and a suggestion for improvement.