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.
1---2name: review-rust-docs3description: Review Rust Docs4---5# Review Rust Docs67Read the documentation of a Rust crate or module to ensure it meets our requirements and standards.89## Arguments10- `<path>`: Path to the Rust crate or file whose documentation needs to be reviewed.11- `<path 1> <path 2>`: Multiple crates/files to review1213If 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`.14If the path points to a directory, review the documentation of all Rust files in that directory.1516## Instructions1718Read the documentation of the specific Rust files and ensure they meet the guidelines outlined in [`rust-docs-guidelines`](../rust-docs-guidelines/SKILL.md).1920Emit a report for all non-conforming locations you find, with an explanation of why they are non-conforming and a suggestion for improvement.
Run npx skillmds@latest add comeonoliver/review-rust-docs in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.
Review Rust Docs It is listed under Coding & Dev Tools on SkillMD.
This skill has not completed SkillMD's automated safety review yet. Independent scanners report: SkillSpector: PASS, Skill Scanner: PASS. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.
This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.
Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.
ComeOnOliver (@comeonoliver) published this skill. Their other Agent Skills are listed on their SkillMD profile.
ComeOnOliver