exploring-rust-crates
Generates and interprets Rust documentation for local crates.
Install
mkdir -p .claude/skills/exploring-rust-crates && curl -L -o skill.zip "https://agentskills.codes/api/skills/download/4241" && unzip -o skill.zip -d .claude/skills/exploring-rust-crates && rm skill.zipInstalls to .claude/skills/exploring-rust-crates
Activation
This is the description your AI agent reads to decide when to run this skill — the better it matches your request, the more reliably it fires.
Generate Rust documentation to understand crate APIs, structure, and usage. Use when exploring Rust code, understanding crate organization, finding functions/types/traits, or needing context about a Rust package in the HASH workspace.Key capabilities
- →Generate documentation for specific packages
- →Document entire workspace crates
- →Include private items in documentation
- →Include feature-gated APIs
- →Exclude dependency documentation
How it works
The skill executes cargo doc commands with specific flags to generate HTML documentation from source code comments and public API definitions.
Inputs & outputs
When to use exploring-rust-crates
- →Generate crate documentation
- →Explore module hierarchy
- →Understand crate public APIs
- →Search for traits and function signatures
About this skill
Exploring Rust Crates
Generate and use Rust documentation to understand crate APIs, structure, and code organization in the HASH workspace.
Generating Documentation
For a Specific Package
cargo doc --no-deps --all-features --package <package-name>
For the Entire Workspace
cargo doc --no-deps --all-features --workspace
Key Flags
--no-deps: Document local code only (faster, less noise)--all-features: Include all feature-gated APIs--package <name>: Target a specific crate--workspace: Document all crates in the workspace--document-private-items: Include internal implementation details
What Generated Docs Provide
- Crate organization - Module hierarchy and component relationships
- Public API surface - All public functions, types, traits, and constants
- Usage examples - Code examples from doctest blocks
- Error documentation - Documented error conditions and handling
- Type relationships - Trait implementations, type aliases, associated types
Viewing Documentation
Docs are generated at:
target/doc/<crate_name>/index.html
Tips
- Generate docs before diving into unfamiliar Rust code
- Cross-reference
# Errorssections for error handling patterns - Look for
# Examplessections for idiomatic usage patterns
When not to use it
- →When documentation for external dependencies is required
Prerequisites
Limitations
- →Requires local source code access
- →Documentation frequency depends on crate encoding settings
How it compares
Unlike manual documentation efforts, this automates the extraction of module hierarchies and type relationships directly from the codebase.
Compared to similar skills
exploring-rust-crates side by side with the closest alternatives in the catalog.
| Skill | Installs | Updated | Safety | Difficulty |
|---|---|---|---|---|
| exploring-rust-crates (this skill) | 3 | 7mo | Review | Beginner |
| rust-learner | 8 | 6mo | Review | Beginner |
| deepwiki-rs | 25 | 9mo | Review | Intermediate |
| writing-user-outputs | 1 | 2mo | Review | Intermediate |
Try saying
Example prompts that trigger this skill in your AI assistant.
More by hashintel
View all by hashintel →You might also like
rust-learner
actionbook
Use when asking about Rust versions or crate info. Keywords: latest version, what's new, changelog, Rust 1.x, Rust release, stable, nightly, crate info, crates.io, lib.rs, docs.rs, API documentation, crate features, dependencies, which crate, what version, Rust edition, edition 2021, edition 2024, cargo add, cargo update, 最新版本, 版本号, 稳定版, 最新, 哪个版本, crate 信息, 文档, 依赖, Rust 版本, 新特性, 有什么特性
deepwiki-rs
sopaco
AI-powered Rust documentation generation engine for comprehensive codebase analysis, C4 architecture diagrams, and automated technical documentation. Use when Claude needs to analyze source code, understand software architecture, generate technical specs, or create professional documentation from any programming language.
writing-user-outputs
max-sixty
CLI output formatting standards for worktrunk. Use when writing user-facing messages, error handling, progress output, hints, warnings, or working with the output system.
sync-upstream
rust-lang-cn
Sync Chinese translation repository with upstream rust-lang/nomicon. Use when user wants to check for upstream changes, sync translations, update from upstream, or asks about differences between local translation and upstream English version. Triggers on requests like "sync upstream", "check upstream changes", "update from nomicon", or "sync translation".
code-review
jonatron55
Instructions for reviewing changes and ensuring quality before completion. Use when asking for a review or before committing changes.
release-rust-srec
hua0512
Prepare a new rust-srec application release end to end — pick the next semver version, bump the workspace version, promote the staged unreleased.md notes into versioned en+zh release-notes pages, reset unreleased, refresh the release-notes index/sidebar/GitHub-body, and emit the rust-srec-vX.Y.Z tag