Menü
Look up Rust crate documentation in Markdown format from target/doc-md/.
Mit Codex oder Claude installieren Kopieren Sie diesen Prompt, fügen Sie ihn in Codex, Claude oder einen anderen Assistant ein und lassen Sie die Skill-Seite prüfen und installieren.
Basierend auf der SOC-Berufsklassifikation
| name | cargo-doc-md |
| description | Look up Rust crate documentation in Markdown format from target/doc-md/. |
Use this skill when you need to look up API signatures, types, or usage examples
for any Rust crate used in this project. Prefer local docs in target/doc-md/
over training data or web lookups -- they match the exact versions in Cargo.lock.
Docs are organized as one directory per crate with Markdown files per module:
target/doc-md/
index.md # Master index of all crates
clap/index.md # Crate root docs
clap/builder.md # clap::builder module
rust_yaml/index.md # rust_yaml crate root
criterion/index.md # criterion crate root
To find docs for a crate, read target/doc-md/<crate_name>/index.md.
For a specific module, read target/doc-md/<crate_name>/<module>.md.
Hyphens in crate names become underscores in directory names (e.g., rust-yaml -> rust_yaml).
Docs should be regenerated when Cargo.lock is newer than target/doc-md/index.md,
which means dependencies were updated.
cargo +nightly doc-md --include-private
cargo +nightly doc-md --include-private -p <crate1> -p <crate2>
rustup install nightly
cargo +nightly install cargo-doc-md
| Crate | Purpose | Doc Path |
|---|---|---|
| clap | CLI argument parser (derive) | target/doc-md/clap/ |
| rust-yaml | YAML parser / emitter | target/doc-md/rust_yaml/ |
| criterion | Benchmark harness (dev-dependency) | target/doc-md/criterion/ |
Run and analyze performance benchmarks. Use when working on performance-critical code or comparing changes.
Run all Rust quality checks (fmt, clippy, test, bench). Use before committing or when validating code changes.
Upgrade Rust dependencies one at a time using cargo outdated. Analyzes impact, checks for API changes, and produces a recommendation before upgrading.
Prepare a pull request with quality checks, commit, and PR creation. Use when ready to submit changes for review.
Run security audit on dependencies and review code for vulnerabilities. Use before releases or when updating dependencies.