rustdoc

Enforce RFC 1574 documentation conventions on public Rust items.

38|5|Updated Feb 24, 2026
One-click install
npx skills add https://github.com/launchapp-dev/animus-cli --skill rustdoc-launchapp-dev
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: rustdoc
Source: https://github.com/launchapp-dev/animus-cli/tree/main/.claude/skills/rustdoc
Command: npx skills add https://github.com/launchapp-dev/animus-cli --skill rustdoc-launchapp-dev

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Rust projects often lack consistent documentation, leading to unclear public APIs. This Skill codifies RFC 1574 conventions to ensure doc comments on public items are clear, well-structured, and maintainable across codebases.

Core Features & Use Cases

  • Enforces a single-sentence summary for each public item and consistent section headings.
  • Uses explicit type references and examples to illustrate usage, improving navigation and comprehension.
  • Use Case: when documenting a crate's public API, apply RFC 1574 rules to produce uniform, discoverable docs.

Quick Start

Document a public Rust item by adding RFC 1574–compliant doc comments with properly formatted sections.

Frequently Asked Questions about rustdoc

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I standardize Rust documentation for a public API?

To standardize Rust documentation, apply RFC 1574 conventions to enforce a single-sentence summary, consistent section headings, explicit type references, and examples for each public item. This ensures uniform, discoverable docs across library crates.

What are the mandatory structures for Rust doc comments under RFC 1574?

RFC 1574 mandates a single-sentence summary for each public item, consistent section headings, explicit type references, and standardized examples. These structures clarify public APIs and improve navigation and comprehension.

How do I add RFC 1574-compliant doc comments to Rust public items?

Document a public Rust item by adding doc comments that include a single-sentence summary, properly formatted section headings, explicit type references, and standardized examples to meet RFC 1574 conventions.

Does this documentation convention apply to internal Rust modules or only public APIs?

RFC 1574 documentation conventions apply specifically to public items within Rust codebases documenting library crates and APIs, ensuring that public-facing doc comments are clear, well-structured, and maintainable.

What is the best way to enforce consistent section headings in Rust documentation?

The best way to enforce consistent section headings is to apply RFC 1574 rules, which standardize the documentation structure for public items, including mandatory summary sentences, type references, and examples.

Why does my Rust crate lack clear and discoverable API documentation?

Rust projects often lack consistent documentation because standard conventions are not applied. Codifying RFC 1574 rules ensures doc comments on public items are well-structured, clear, and maintainable across codebases.