Exploring Rust Crates

SkillDocs & knowledge

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.

Available today. Use it from your connected AI after setup.

Connect ahel once, and every AI you use reads what you have installed.

Then ask your AI: use the Exploring Rust Crates skill

What this skill tells your AI

The instructions your AI receives, as published by hashintel/hash in .agents/skills/exploring-rust-crates/SKILL.md and read by ahel’s review.

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

Signals

GitHub stars
2k
Forks
123
Last commit
Sep 2026
Advanced
Catalog kind
skill
Gateway key
exploring-rust-crates
Source
github.com/hashintel/hash