rust-docs

What problem does it solve?

This Skill provides standards for module, function, and trait documentation in Rust, enabling consistent, navigable, and testable docs.

Core Features & Use Cases

• Module docs: Module-level overview and examples.
• Function docs: Arguments, returns, errors, panics, and examples.
• Linking & tests: Cross-references and doc tests to ensure accuracy.
• Use Case: Document a public API surface with examples and error cases for users.

Quick Start

Add documentation blocks to a public function and run cargo doc to verify.