# Rust Docs Guidelines

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

Guidelines for writing Rust documentation. Use this when you want to write Rust documentation.

- Skill name: `rust-docs-guidelines`
- Category: [Development](https://www.openparable.com/skill/development/1)
- Source: https://github.com/RediSearch/RediSearch/blob/HEAD/.skills/rust-docs-guidelines/SKILL.md
- Repository: RediSearch/RediSearch (6,175 GitHub stars when collected)

## SKILL.md

# Rust Docs Guidelines

Standards to follow when writing Rust documentation.

## Guidelines

- Key concepts should be explained only once. All other documentation should use an intra-documentation link to the first explanation.
- Always use an intra-documentation link when mentioning a Rust symbol (type, function, constant, etc.).
- Avoid referring to specific lines or line ranges, as they may change over time.
  Use line comments if the documentation needs to be attached to a specific code section inside
  a function/method body.
- Focus on why, not how.
  In particular, avoid explaining trivial implementation details in line comments.
- Refer to constants using intra-documentation links. Don't hard-code their values in the documentation of other items.
- Intra-documentation links to private items are preferable to duplication. Add `#[allow(rustdoc::private_intra_doc_links)]` where relevant.

---

Source: https://www.openparable.com/skill/development/rust-docs-guidelines (OpenParable). Cite the canonical URL above.
