Deepwiki Rs
sopaco/deepwiki-rs
AI-powered Rust documentation generation engine for comprehensive codebase analysis, C4 architecture diagrams, and automated technical documentation.
Write or substantially revise a Rust crate's README.md as a concise, user-facing design document.
Install Crate Readme Writer
$ npx skills add Devolutions/IronRDP --skill crate-readme-writer -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install Devolutions/IronRDP crate-readme-writer --agent claude-codeProject scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).
$ git clone --depth 1 https://github.com/Devolutions/IronRDP.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/crate-readme-writer .claude/skills/crate-readme-writer && rm -rf skills-srcUse ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.
Claude Code skills documentation · loads skills from .claude/skills/
Install the "crate-readme-writer" agent skill from https://github.com/Devolutions/IronRDP/tree/master/.agents/skills/crate-readme-writer into .claude/skills/crate-readme-writer/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "crate-readme-writer", then confirm the skill loads.Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$skill-installer install https://github.com/Devolutions/IronRDP/tree/master/.agents/skills/crate-readme-writerType this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.
$ npx skills add Devolutions/IronRDP --skill crate-readme-writer -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install Devolutions/IronRDP crate-readme-writer --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/Devolutions/IronRDP.git skills-src && mkdir -p .agents/skills && cp -r skills-src/.agents/skills/crate-readme-writer .agents/skills/crate-readme-writer && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "crate-readme-writer" agent skill from https://github.com/Devolutions/IronRDP/tree/master/.agents/skills/crate-readme-writer into .agents/skills/crate-readme-writer/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "crate-readme-writer", then confirm the skill loads.Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add Devolutions/IronRDP --skill crate-readme-writer -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install Devolutions/IronRDP crate-readme-writer --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/Devolutions/IronRDP.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/.agents/skills/crate-readme-writer .cursor/skills/crate-readme-writer && rm -rf skills-srcUse ~/.cursor/skills/ instead of .cursor/skills for a personal install.
Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/
Install the "crate-readme-writer" agent skill from https://github.com/Devolutions/IronRDP/tree/master/.agents/skills/crate-readme-writer into .cursor/skills/crate-readme-writer/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "crate-readme-writer", then confirm the skill loads.Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gemini skills install https://github.com/Devolutions/IronRDP.git --path .agents/skills/crate-readme-writer--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.
$ npx skills add Devolutions/IronRDP --skill crate-readme-writer -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install Devolutions/IronRDP crate-readme-writer --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/Devolutions/IronRDP.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/.agents/skills/crate-readme-writer .gemini/skills/crate-readme-writer && rm -rf skills-srcUse ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.
Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/
Install the "crate-readme-writer" agent skill from https://github.com/Devolutions/IronRDP/tree/master/.agents/skills/crate-readme-writer into .gemini/skills/crate-readme-writer/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "crate-readme-writer", then confirm the skill loads.Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gh skill install Devolutions/IronRDP crate-readme-writerInstalls for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).
$ npx skills add Devolutions/IronRDP --skill crate-readme-writer -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/Devolutions/IronRDP.git skills-src && mkdir -p .github/skills && cp -r skills-src/.agents/skills/crate-readme-writer .github/skills/crate-readme-writer && rm -rf skills-srcUse ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.
GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/
Install the "crate-readme-writer" agent skill from https://github.com/Devolutions/IronRDP/tree/master/.agents/skills/crate-readme-writer into .github/skills/crate-readme-writer/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "crate-readme-writer", then confirm the skill loads.GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add Devolutions/IronRDP --skill crate-readme-writer -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install Devolutions/IronRDP crate-readme-writer --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/Devolutions/IronRDP.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/.agents/skills/crate-readme-writer .opencode/skills/crate-readme-writer && rm -rf skills-srcUse ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.
OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/
Install the "crate-readme-writer" agent skill from https://github.com/Devolutions/IronRDP/tree/master/.agents/skills/crate-readme-writer into .opencode/skills/crate-readme-writer/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "crate-readme-writer", then confirm the skill loads.OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
Facts
- Skill name
crate-readme-writer- GitHub stars
- 3.2k
- Token cost
- ~455 tokens
- SKILL.md length
- 209 words
- Files
- 1
- Skills in repo
- 8
- Repo updated
- First seen
- Licence
- Apache-2.0
At a glance
Write or substantially revise a Rust crate's README.md as a concise, user-facing design document.
- Creating a crate README
- Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
- Documenting a planned crate
- Defining a crates purpose
What it does
Crate Readme Writer is an agent skill from Devolutions/IronRDP. Write or substantially revise a Rust crate's README.md as a concise, user-facing design document. Use whenever creating a crate README, documenting a planned crate, or defining a crate's purpose, role, or interface before implementation.
Its SKILL.md is about 460 tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.
It sits in Development, covering Technical documentation. It works with Rust. The repository describes itself as: Rust implementation of the Microsoft Remote Desktop Protocol (RDP). The licence is Apache-2.0.
When your agent uses it
- Creating a crate README
- Documenting a planned crate
- Defining a crates purpose
- Interface before implementation
Example prompts
- “/crate-readme-writer”
What it can do on your machine
Read from SKILL.md and the folder at commit 0e9dc1f. It shows what the files ask for, not the result of running them.
Tool permissions
Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.
From allowed-tools in the SKILL.md frontmatter.
Runs code
No scripts in the folder and no shell commands in SKILL.md.
From the folder's file list and the shell code blocks in SKILL.md.
Network
Links to these hosts (documentation or services it may open):
tom.preston-werner.com
From URLs in SKILL.md, links to its own repository left out.
Credentials
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.
Context cost
Crate Readme Writer loads about 455 tokens when it runs. Until then it costs about 64 tokens; SKILL.md has 209 words of instructions outside code blocks.
Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.
Safety
Auto-check passed
The automated check found no risky patterns in SKILL.md.
Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.
SKILL.md
The full file from Devolutions/IronRDP at commit 0e9dc1f, republished under its Apache-2.0 licence (© Devolutions). 209 words, ~455 tokens.
Download SKILL.mdSave it as
.claude/skills/crate-readme-writer/SKILL.md (or your agent's skills folder).- name
- crate-readme-writer
- description
- Write or substantially revise a Rust crate's README.md as a concise, user-facing design document. Use whenever creating a crate README, documenting a planned crate, or defining a crate's purpose, role, or interface before implementation.
Crate README writer
Invoke docs-writer and apply its rules throughout.
For a new crate, write the README before implementing behavior. Use it as a lightweight specification: changing prose and examples is cheaper than changing code, and a written proposal gives collaborators a concrete design to review. For an existing crate, inspect its manifest and implementation first so the README describes current behavior rather than an imagined interface.
- Identify the intended reader, the problem the crate solves, and why it belongs in the repository.
- Lead with the crate name and a one- or two-sentence description of its purpose.
- Describe the smallest useful contract: principal capability, expected integration point, and important platform or architectural constraints.
- Add a minimal usage example only when it clarifies the intended API better than prose.
- Revise the proposed interface until it is coherent before committing to implementation details.
- Treat a long or complicated README as design feedback: narrow or split the crate instead of writing an exhaustive specification.
- Link to existing project or protocol documentation rather than duplicating it.
- After implementation, verify every claim and example against the code while preserving the README's concise introductory role.
Write README.md directly.
Keep it short enough to expose unclear scope and unnecessary complexity.
This workflow follows Readme Driven Development.
© Devolutions, Apache-2.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file
Files
Just SKILL.md in .agents/skills/crate-readme-writer of Devolutions/IronRDP.
Open the folder on GitHubat commit 0e9dc1f
Compare with similar skills
Crate Readme Writer next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.
| Skill | Stars | Used in | Tokens | Auto-check | Licence | Repo updated |
|---|---|---|---|---|---|---|
| Crate Readme Writer this skillDevolutions/IronRDP | 3.2k | — | ~455 | Automated safety check: Pass | Apache-2.0 | |
| Deepwiki Rssopaco/deepwiki-rs | 3.1k | — | ~748 | Automated safety check: Pass | MIT | |
| Releasejaemk/self_update | 961 | — | ~2.2k | Automated safety check: Pass | MIT | |
| Translate It Doc En Zhmxsm/rocketmq-rust | 1.5k | — | ~1.2k | Automated safety check: Pass | Apache-2.0 | |
| Codex Proxy RS Development Guidezyycn/codex-proxy-rs | 750 | — | ~618 | Automated safety check: Pass | Apache-2.0 | |
| Signal Over NoiseJamieMason/syncpack | 2.1k | — | ~1.5k | Automated safety check: Pass | MIT |
Similar skills
Release
jaemk/self_update
Prepare a release (bump the crate version, update CHANGELOG.md with a migration guide for breaking changes, regenerate README, commit), or run a pre-release review.
Translate It Doc En Zh
mxsm/rocketmq-rust
Translate English IT and software engineering documents into professional, accurate Chinese.
Codex Proxy RS Development Guide
zyycn/codex-proxy-rs
Routes development, troubleshooting, review and documentation tasks on the Codex Proxy RS repository to the right section of its docs, instead of loading the whole architecture or contributing guide.
Signal Over Noise
JamieMason/syncpack
Maximize useful information per word by removing filler, obvious explanations, and hedging language.
Writing Review
mxpv/openusd
Revise drafted prose into the plain, reader-facing register this project uses: commit messages, doc comments and inline comments, README and docs/ pages, ROADMAP notes, and the prose in plans and…
More from Devolutions/IronRDP
All 8 skills in this repoCommit Scope
Devolutions/IronRDP
Derive and validate the canonical scope for IronRDP Conventional Commit and pull-request titles.
Ironrdp Activex Mstsc Testing
Devolutions/IronRDP
Test IronRDP ActiveX in the real mstsc.exe child launched by MsRdpEx, including the native credential bridge, shell behavior, resize handling, clipboard startup, and bounded UI stress.
Release Prep
Devolutions/IronRDP
Reviews and finalizes a release-plz "chore(release): prepare for publishing" PR for the IronRDP workspace.
New Crate
Devolutions/IronRDP
Create and integrate a new Rust crate in the IronRDP workspace.
Public Dependency
Devolutions/IronRDP
Add or change Rust crate dependencies while preserving IronRDP's public-dependency markers.
Code Review
Devolutions/IronRDP
Review IronRDP pull requests and diffs using focused protocol, compression, prose, and skeptical passes.
Related
Works with
Categories
Questions about Crate Readme Writer
What does Crate Readme Writer do?
Write or substantially revise a Rust crate's README.md as a concise, user-facing design document. Crate Readme Writer is an agent skill from Devolutions/IronRDP.md as a concise, user-facing design document.
When should I use Crate Readme Writer?
Crate Readme Writer fits situations like: creating a crate README; documenting a planned crate; defining a crates purpose; interface before implementation.
How do I install Crate Readme Writer in Claude Code?
Run `npx skills add Devolutions/IronRDP --skill crate-readme-writer -a claude-code`. Or copy the skill folder (.agents/skills/crate-readme-writer in Devolutions/IronRDP) into .claude/skills/crate-readme-writer in your project. Claude Code loads it when a task matches its description.
How do I install Crate Readme Writer in Codex?
Run `npx skills add Devolutions/IronRDP --skill crate-readme-writer -a codex`. Or copy the skill folder (.agents/skills/crate-readme-writer in Devolutions/IronRDP) into .agents/skills/crate-readme-writer in your project. Codex loads it when a task matches its description.
Can I use Crate Readme Writer in Cursor, Gemini CLI or GitHub Copilot?
Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add Devolutions/IronRDP --skill crate-readme-writer -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/crate-readme-writer, .gemini/skills/crate-readme-writer, .github/skills/crate-readme-writer and .opencode/skills/crate-readme-writer in your project.
What does Crate Readme Writer need to run?
SKILL.md names no scripts, command-line tools or credentials: Crate Readme Writer is instructions for the agent only.
Does Crate Readme Writer access the network?
SKILL.md names 1 domain. As links in the text: tom.preston-werner.com. This is read from the text; nothing was executed.
Is Crate Readme Writer safe to install?
Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.
What licence does Crate Readme Writer use?
Crate Readme Writer is published under the Apache-2.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.
How many tokens does Crate Readme Writer use?
About 455 tokens (SKILL.md is roughly 1.8k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.
What are the alternatives to Crate Readme Writer?
Skills that share tags, products or a category with Crate Readme Writer: Deepwiki Rs (sopaco/deepwiki-rs, 3.1k stars), Release (jaemk/self_update, 961 stars), Translate It Doc En Zh (mxsm/rocketmq-rust, 1.5k stars) and Codex Proxy RS Development Guide (zyycn/codex-proxy-rs, 750 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains Crate Readme Writer?
Devolutions (a GitHub organization) maintains it in Devolutions/IronRDP, which has 3,213 GitHub stars. The repository holds 8 skills in this directory. The repository was last updated on October 8, 2026.
Source: Devolutions/IronRDP on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.