Rewrite Rustdoc
CheckedRewrites Rustdoc comments for improved clarity and consistency, streamlining documentation and boosting developer understanding.
Install on your platform
Showing Claude Code. One command installs this skill into any of the agents below.
- 1
Run this in your project
terminal$ npx skills add jim60105/copilot-prompt --skill rewrite-rustdoc -a claude-code Uses the open-source
skillsCLI and needs Node.js. Add-gto install it for your user instead of this project.
What we know about this skill
Publisher
jim60105
Taken from the source listing. We haven't verified who controls this account.
Install target
Live repository
Not pinned. Installing fetches whatever the repository holds at the time you run the command.
Automated safety checks
This skill passed all 6 checks. We read its files at one commit and looked for the things that make a skill dangerous to run — not for whether it works.
Declares what it does: passed
SKILL.md parses and declares a name and a description.
SKILL.md exists, its frontmatter parses, and it declares a name and a description.
No undeclared network calls: passed
Makes no network calls.
Every host the skill dials — from its scripts, its config endpoints or the commands it tells the agent to run — is either well-known package and API infrastructure or declared in its own frontmatter. Links in documentation are not counted.
No obfuscated payloads: passed
No encoded or obfuscated payloads.
No base64, hex or compressed blob is decoded and then executed, and no encoded shell commands.
No credential access: passed
Reads no keys, tokens, keychains or credential files.
Neither the code nor the SKILL.md instructions read SSH keys, cloud credentials, keychains, token stores, browser cookie databases or dotfiles that hold secrets.
No pipe-to-shell installers: passed
No pipe-to-shell or download-and-run installers.
No `curl … | sh` pattern, in the code or in the instructions, that runs code fetched at run time.
Pinned to a commit: passed
Scanned jim60105/copilot-prompt at 6911cf8cdb.
The exact upstream commit SHA that was scanned is recorded, so the result refers to specific bytes.
- Commit
- 6911cf8cdb
- Manifest
- skills/rewrite-rustdoc/SKILL.md
- Scanned
- 1 file, 39 lines
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.