rust-docs-guidelines

What problem does it solve?

This Skill provides standardized guidelines for writing Rust documentation to improve clarity, consistency, and maintainability across crates and modules.

Core Features & Use Cases

• Intra-doc-link strategy: use intra-document links to refer to related items rather than repeating explanations.
• Doc-comment conventions: write idiomatic Rust doc-comments, module docs, and examples that illustrate usage.
• Structure and focus: avoid referencing specific implementation details or line numbers; emphasize why and how to use the API.
• Use Case: teams documenting large codebases can adopt a uniform documentation style for easier onboarding and maintenance.

Quick Start

Generate Rust module docs following the Rust Docs Guidelines, including doc-comments and intra-doc-links.