// 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.
| name | 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 | AGPL-3.0 |
| metadata | {"triggers":{"type":"domain","enforcement":"suggest","priority":"medium","keywords":["cargo doc","rust documentation","crate api","rust crate","module hierarchy"],"intent-patterns":["\\b(explore|understand|learn)\\b.*?\\b(rust|crate|package)\\b","\\b(what|how)\\b.*?\\b(functions|types|traits|api)\\b.*?\\bcrate\\b","\\bdocument(ation)?\\b.*?\\brust\\b"]}} |
Generate and use Rust documentation to understand crate APIs, structure, and code organization in the HASH workspace.
cargo doc --no-deps --all-features --package <package-name>
cargo doc --no-deps --all-features --workspace
--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 detailsDocs are generated at:
target/doc/<crate_name>/index.html
# Errors sections for error handling patterns# Examples sections for idiomatic usage patternsUse when creating, moving, splitting, or organizing TypeScript files and folders. Applies fractal tree file-structuring rules which reduce the cognitive overhead of choosing where to put files and ultimately navigating a codebase (once the structure is established and understood).
HashQL testing strategies including compiletest (UI tests), unit tests, and snapshot tests. Use when writing tests for HashQL code, using //~ annotations, running --bless, debugging test failures, or choosing the right testing approach.
Rust documentation practices for HASH codebase. Use when writing doc comments, documenting functions/types/traits/modules, creating error sections, using intra-doc links, or following rustdoc conventions.
HASH error handling patterns using error-stack crate. Use when working with Result types, Report types, defining custom errors, propagating errors with change_context, adding context with attach, implementing Error trait, or documenting error conditions in Rust code.
Guide for creating effective Agent Skills. Use when users want to create a new skill (or update an existing skill) that extends an AI agent's capabilities with specialized knowledge, workflows, or tool integrations. Covers skill structure, YAML frontmatter, trigger configuration, and the 500-line rule.
HashQL diagnostic writing patterns using hashql-diagnostics crate. Use when creating error messages, warnings, Labels, Messages, Severity levels, Patches, Suggestions, or improving diagnostic quality in HashQL code.