---
description: Rust Documentation Practices
globs: "**/*.rs"
alwaysApply: false
---

# Rust Documentation Practices

Detailed documentation guidelines are maintained in:

- `.claude/skills/documenting-rust-code/SKILL.md` - Main guidelines
- `.claude/skills/documenting-rust-code/resources/` - Detailed patterns

## Quick Reference

Key points:

- Begin doc comments with single-line summary
- Use intra-doc links liberally: [`Vec`], [`HashMap`], etc.
- Document errors with `# Errors` section
- Include examples for public APIs with `# Examples`
- Use `cargo doc --no-deps --all-features` to verify