rustdoc
CommunityMaster Rust documentation standards.
Authornubiv
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill helps developers adhere to the official Rust documentation conventions (RFC 1574), ensuring clarity, consistency, and discoverability in their code documentation.
Core Features & Use Cases
- Standardized Doc Comments: Learn the correct format for summary sentences, comment styles, and section headings.
- Effective Linking: Understand how to reference types and external documentation.
- Comprehensive Sections: Implement essential sections like
# Examples,# Panics,# Errors, and# Safety. - Use Case: When documenting a new public Rust function, use this Skill to ensure your doc comments follow best practices, making your library easier for others to understand and use.
Quick Start
Apply the rustdoc skill to write clear and conventional documentation comments for your Rust code.
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: rustdoc Download link: https://github.com/nubiv/my-nome/archive/main.zip#rustdoc 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.