Individual skill
rustdoc-library-documentation
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.
plugins/LVTD-LLC/skills/skills/rustdoc-library-documentation/SKILL.md
Source commit d780783eba4ecc7c8b9429f95c9362df95f07c61
What was checked
- Matches the observed repository HEAD
- Yes
- Scanner rules are current
- No
- Repository scan complete
- No
- Skill scan complete
- No
- Observed behavior
- Not checked yet
- Last checked
- Nov 4, 2026
These are observations at the recorded commit, not a guarantee of safety. Review the source before running it.
Install this skill
Choose an agent in your Stack or copy a command below. Commands fetch the pinned commit and copy only this skill directory. Existing destinations are refused. Copying a command does not install anything.
An install command is unavailable: current rules, complete repository and skill scans, an eligible behavior level and a permitted license are required.
Repository context
- Repository stars (not skill ratings)
- 1,538
- Repository last updated
- Nov 7, 2026
- License
- Apache-2.0
Observed agent integration: No specific integration evidence. Standard SKILL.md installation does not imply verified compatibility.
- ai-coding Repository topic
- awesome Repository topic
- awesome-list Repository topic
- codex Repository topic
- codex-plugins Repository topic
- openai Repository topic
- codex-skill Repository topic
- codex-skills Repository topic
- marketplace Repository topic
- codex-marketplace Repository topic
- rust,rustdoc,documentation,doctests,library Declared skill tag
- docs Derived category
Files and excerpt
File metadata and permitted, redacted excerpts come from the recorded scan. Source links are pinned to that commit.
Browse files
SKILL.mdcore · 1,644 bytesagents/openai.yamlasset · 225 bytesguidelines.mddoc · 1,373 bytesreferences/rustdoc-patterns.mddoc · 2,207 bytesworkflows/document-library.mddoc · 1,971 bytes
Read excerpt
# Rustdoc Library Documentation
Use this skill to make Rust library documentation executable, navigable, and
useful to downstream crate consumers.
## Core Workflow
1. Start from the consumer's first task, not from internal module order.
2. Add crate-level and module-level docs that explain purpose and boundaries.
3. Document public types, functions, errors, features, and invariants.
4. Prefer short compiling examples and doctests for core APIs.
5. Put longer scenarios in `examples/` and reference them from docs.
6. Run docs and doctests before publishing.
