---
name: hashintel-exploring-rust-crates
description: "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."
license: "NOASSERTION"
metadata:
  decimalai-skill-id: "7c9d98a7-e665-40a0-b90f-f646f1e60163"
  decimalai-version-id: "b0dbdb7a-f823-486f-a670-05e60b9c8d91"
  decimalai-version: "1"
  decimalai-body-sha256: "70245ee15860acc23b81215caefd195e7ec3a1b2374dbc86e9e701f393dc617b"
  decimalai-name: "hashintel/exploring-rust-crates"
  decimalai-format: "1"
  decimalai-invocation: "model"
  decimalai-category: "documentation"
  decimalai-source: "https://app.decimal.ai/s/hashintel-exploring-rust-crates@1/SKILL.md"
---
# 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

```bash
cargo doc --no-deps --all-features --package <package-name>
```

### For the Entire Workspace

```bash
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:

```txt
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