rust-documentation
CommunityGuide Rust docs with best practices.
AuthorJLSed
Version1.0.0
Installs0
System Documentation
What problem does it solve?
Rust codebases often lack consistent documentation, leading to maintenance challenges and onboarding friction.
Core Features & Use Cases
- Enforces doc comments on all public items (functions, structs, enums, traits) with clear rationale ("why" and "what").
- Provides a standard rustdoc template, including section structure, cross-references, and module-level docs across Rust/WASM components.
- Supports crypto-related code by embedding security notes and practical examples to drive secure documentation.
Quick Start
Document a new Rust module by adding public doc comments and module-level notes following the standard template.
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: rust-documentation Download link: https://github.com/JLSed/Novault/archive/main.zip#rust-documentation Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.