exploring-rust-crates

hashintel's avatarfrom hashintel

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.

⭐1.4kstars🔀110forks📁View on GitHub🕐Updated Jan 10, 2026
[Developer Tools]

When & Why to Use This Skill

This Claude skill automates the generation and exploration of Rust crate documentation using cargo doc. It helps developers quickly grasp complex API structures, module hierarchies, and code examples within a HASH workspace, significantly accelerating the code discovery process and improving developer productivity.

Use Cases

  • Onboarding to new projects: Rapidly generate a comprehensive overview of a Rust crate's architecture and public API surface to understand how different components interact.
  • API Reference Lookup: Efficiently find specific function signatures, trait implementations, and type definitions without manually searching through source files.
  • Learning Idiomatic Usage: Extract and review code examples from doctest blocks to understand the intended usage patterns of specific Rust packages.
  • Dependency Analysis: Explore the module hierarchy and relationships between different crates within a large workspace to better manage code organization.
nameexploring-rust-crates
descriptionGenerate 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.
licenseAGPL-3.0
typedomain
enforcementsuggest
prioritymedium

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

  1. Crate organization - Module hierarchy and component relationships
  2. Public API surface - All public functions, types, traits, and constants
  3. Usage examples - Code examples from doctest blocks
  4. Error documentation - Documented error conditions and handling
  5. 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 # Errors sections for error handling patterns
  • Look for # Examples sections for idiomatic usage patterns