Loading skill
Install any skill in seconds. Free to start, no credit card required.
Get Started Free →Write and review Rust library documentation with rustdoc module docs, public API examples, doctests, examples directories, missing-docs gates, docs.rs readiness, and user-first crate narratives. Use when documenting a Rust crate, improving docs before publishing, or turning examples into tested rustdoc.
.claude/skills/hashgraph-online-rustdoc-library-documentation/SKILL.md| Test case | Without → With | Effect | Δ tokens | Δ turns |
|---|---|---|---|---|
| case-13 | ✗→✓ | ▲ Improved | -41% | 0% |
| case-12 | ✓→✓ | ＝ Same ✓ | -26% | 0% |
| case-22 | ✓→✓ | ＝ Same ✓ | -15% | 0% |
| case-02 | ✓→✓ | ＝ Same ✓ | -16% | 0% |
| case-03 | ✓→✓ | ＝ Same ✓ | -5% | 0% |
Use this skill to make Rust library documentation executable, navigable, and useful to downstream crate consumers.
examples/ and reference them from docs.| 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 |
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.
Other measured skills in the registry, with their headline benchmark lift.