review-rust-docs
This tool checks Rust crate documentation against guidelines and reports sections that require improvement.
Install
mkdir -p .claude/skills/review-rust-docs && curl -L -o skill.zip "https://agentskills.codes/api/skills/download/6264" && unzip -o skill.zip -d .claude/skills/review-rust-docs && rm skill.zipInstalls to .claude/skills/review-rust-docs
Activation
This is the description your AI agent reads to decide when to run this skill — the better it matches your request, the more reliably it fires.
Review the documentation of a Rust crate to ensure it meets our requirements and standards. Use this when you have done changes to Rust code.Key capabilities
- →Review documentation of a Rust crate or module
- →Identify non-conforming sections in Rust documentation
- →Provide explanations for non-conformance
- →Suggest improvements for Rust documentation
- →Review all Rust files in a specified directory
How it works
This skill reads the documentation of specified Rust files and checks them against `rust-docs-guidelines`. It then generates a report detailing any non-conforming locations.
Inputs & outputs
When to use review-rust-docs
- →Review Rust crate docs
- →Validate documentation standards
- →Audit source code comments
About this skill
Review 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.
How it compares
This skill automates the process of checking Rust documentation against predefined guidelines, providing structured feedback instead of manual review.
Compared to similar skills
review-rust-docs side by side with the closest alternatives in the catalog.
| Skill | Installs | Updated | Safety | Difficulty |
|---|---|---|---|---|
| review-rust-docs (this skill) | 1 | 5mo | No flags | Beginner |
| documenting-rust-code | 1 | 2mo | Review | Beginner |
| deepwiki-rs | 25 | 9mo | Review | Intermediate |
| code-review | 0 | 6mo | No flags | Intermediate |
Try saying
Example prompts that trigger this skill in your AI assistant.
More by RediSearch
View all by RediSearch →You might also like
documenting-rust-code
hashintel
Rust documentation practices for HASH codebase. Use when writing doc comments, documenting functions/types/traits/modules, creating error sections, using intra-doc links, or following rustdoc conventions.
deepwiki-rs
sopaco
AI-powered Rust documentation generation engine for comprehensive codebase analysis, C4 architecture diagrams, and automated technical documentation. Use when Claude needs to analyze source code, understand software architecture, generate technical specs, or create professional documentation from any programming language.
code-review
jonatron55
Instructions for reviewing changes and ensuring quality before completion. Use when asking for a review or before committing changes.
rust-docs-guidelines
RediSearch
Guidelines for writing Rust documentation
write-documentation
r3bl-org
Write and format Rust documentation correctly. Apply proactively when writing code with rustdoc comments (//! or ///). Covers voice & tone, prose style (opening lines, explicit subjects, verb tense), structure (inverted pyramid), intra-doc links (crate:: paths, reference-style), constant conventions (binary/byte literal/decimal), and formatting (cargo rustdoc-fmt). Also use retroactively via /fix-intradoc-links, /fix-comments, or /fix-md-tables commands.
doc-cli-usage
BA-CalderonMorales
Use the Rust-based documentation CLI for common tasks.