home / skills / redisearch / redisearch / review-rust-docs

review-rust-docs skill

safe

This skill reviews Rust crate documentation to ensure it meets our standards, providing actionable feedback and improvement suggestions for conformance and

npx playbooks add skill redisearch/redisearch --skill review-rust-docs

Review the files below or copy the command above to add this skill to your agents.

Files (1)

SKILL.md

992 B

---
name: review-rust-docs
description: Review the documentation of a Rust crate to ensure it meets our requirements and standards.
---

# 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`](../rust-docs-guidelines/SKILL.md).

Emit a report for all non-conforming locations you find, with an explanation of why they are non-conforming and a suggestion for improvement.

Overview

This skill reviews Rust crate and module documentation to ensure it meets the project's Rust documentation guidelines and quality standards. It scans specified files or directories, identifies missing or non-conforming items, and produces actionable reports with clear improvement suggestions. The output is a prioritized list of documentation issues tied to specific code locations.

How this skill works

Point the skill to one or more file or directory paths; if a path omits src/, the tool assumes src/redisearch_rs as the base. It parses the Rust source and public API docs, checks doc comments, examples, module-level docs, and attribute usage against the Rust documentation guidelines. For each non-conformance it emits a focused report explaining why it fails and how to fix it, including suggested wording or code snippets where useful.

When to use it

Before merging a feature or refactor that changes public APIs or behavior
When preparing a release to ensure docs are complete and consistent
During code review to catch missing examples, unclear explanations, or stale remarks
To audit a crate or module for user-facing documentation quality
When onboarding new maintainers to enforce documentation standards

Best practices

Provide the exact file or directory path(s) to review; omit src/ to use the default src/redisearch_rs location
Run the review after code changes but before tagging releases to avoid stale docs
Include examples and expected output for functions that have non-trivial behavior
Prefer concrete, minimal examples and cross-reference related modules where helpful
Fix issues incrementally and re-run the review to confirm compliance

Example use cases

Review documentation for a new numeric range tree module to ensure examples and edge cases are documented
Scan all Rust files under a module directory to find missing module-level documentation or broken links
Validate public API docs for a new search or vector similarity feature before release
Identify undocumented public functions, unclear parameter descriptions, or absent examples
Generate a prioritized checklist of doc fixes to present in a pull request

FAQ

What input paths are accepted?

Single file paths, multiple file paths, or directories. If the path lacks src/, src/redisearch_rs is used as the default base.

What does the report include?

A list of non-conforming locations with explanations, severity or priority, and suggested corrections or example wording.