Rewrite Rustdoc
Rewrites Rustdoc comments for improved clarity and consistency, streamlining documentation and boosting developer understanding.
Install on your platform
We auto-selected Claude Code based on this skill’s supported platforms.
Run in terminal (recommended)
claude mcp add rewrite-rustdoc npx -- -y @trustedskills/rewrite-rustdoc
Or manually add to ~/.claude/settings.json
{
"mcpServers": {
"rewrite-rustdoc": {
"command": "npx",
"args": [
"-y",
"@trustedskills/rewrite-rustdoc"
]
}
}
}Requires Claude Code (claude CLI). Run claude --version to verify your install.
About This Skill
What it does
This skill rewrites Rustdoc documentation to improve clarity and readability. It can rephrase complex explanations, simplify technical jargon, and ensure consistency in terminology across a project's documentation. The rewritten documentation maintains the original meaning while being more accessible to a wider audience.
When to use it
- Improving onboarding: Help new developers quickly understand existing codebases by clarifying confusing documentation.
- Public API documentation: Generate user-friendly documentation for public APIs, making them easier for external users to adopt.
- Internal knowledge sharing: Enhance internal documentation to facilitate better communication and collaboration within development teams.
- Refactoring large projects: Simplify complex codebases by rewriting accompanying documentation alongside the refactor.
Key capabilities
- Rewrites Rustdoc comments
- Simplifies technical language
- Improves clarity of explanations
- Maintains original meaning
Example prompts
- "Rewrite this Rustdoc comment:
/// This function does a thing.to be more descriptive." - "Simplify the explanation in this Rustdoc block for the
MyStructtype." - "Rephrase this documentation section to use less technical jargon."
Tips & gotchas
This skill is most effective when provided with complete and accurate Rustdoc comments. While it aims to preserve meaning, review rewritten documentation carefully to ensure accuracy and completeness.
Tags
TrustedSkills Verification
Unlike other registries that point to live repositories, TrustedSkills pins every skill to a verified commit hash. This protects you from malicious updates — what you install today is exactly what was reviewed and verified.
Security Audits
| Gen Agent Trust Hub | Pass |
| Socket | Pass |
| Snyk | Pass |
🌐 Community
Passed automated security scans.