OpenParable
Skip to content
← Back to skills

Review Rust Docs

Testing & Quality
review-rust-docs

Review Rust Docs is an Agent Skill for testing & quality published in the RediSearch/RediSearch repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

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.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/RediSearch/RediSearch/blob/HEAD/.skills/review-rust-docs/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/review-rust-docs, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

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.