review-rust-docs

Official

Audit Rust crate docs for standards.

AuthorRediSearch
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill helps ensure Rust crate documentation meets project standards by systematically auditing docs and identifying non-conformances.

Core Features & Use Cases

  • Audits Rust crate docs against established Rust documentation guidelines.
  • Generates a prioritized report detailing non-conforming sections, with explanations and concrete improvement suggestions.
  • Use Case: A Rust library maintainer runs this Skill to verify that crate docs align with the rust-docs-guidelines before releasing a new version.

Quick Start

Run the skill against the target crate directory, such as the crate source or cargo-generated docs, to initiate the audit and receive a structured report.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: review-rust-docs
Download link: https://github.com/RediSearch/RediSearch/archive/main.zip#review-rust-docs

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.