thedixitjain Rustdoc Library Documentation
Use this skill to make Rust library documentation executable, navigable, and useful to downstream crate consumers.
Core Workflow
- Start from the consumer's first task, not from internal module order.
- Add crate-level and module-level docs that explain purpose and boundaries.
- Document public types, functions, errors, features, and invariants.
- Prefer short compiling examples and doctests for core APIs.
- Put longer scenarios in
examples/and reference them from docs. - Run docs and doctests before publishing.
Read Next
| Task | Load |
|---|---|
| Document a public crate API | guidelines.md, workflows/document-library.md |
| Add doctests or examples | references/rustdoc-patterns.md |
| Prepare docs for publishing | references/rustdoc-patterns.md |
Source Notes
Guidance is transformed and paraphrased from Herbert Wolverson, Advanced Hands-On Rust, especially Chapter 4 on documenting a library and Chapter 15 on sharing crates. Examples are original skeletons.
Source: hashgraph-online/awesome-codex-plugins → plugins/LVTD-LLC/skills/skills/rustdoc-library-documentation/SKILL.md