exploring-rust-crates

This skill assists developers in navigating the HASH Rust codebase by providing automated documentation generation using cargo doc. It is designed for engineers who need to quickly grasp the architecture of a new or unfamiliar crate, identify public API surfaces, or understand complex type hierarchies. By leveraging this tool, you can generate comprehensive HTML documentation that maps out module boundaries and dependencies within the workspace, facilitating a deeper understanding of how different components interact.

• Automatically runs cargo doc with optimized flags like --no-deps and --all-features for efficient, relevant documentation generation.

• Provides clear navigation paths for local documentation hosted at target/doc/index.html.

• Highlights critical API surface areas including public functions, traits, constants, and type aliases.

• Enables investigation of trait implementations, associated types, and module hierarchy structures.

• Facilitates the study of error handling patterns by cross-referencing documented error conditions.

• Use this skill when you encounter unfamiliar Rust packages or need to understand the structural organization of the HASH workspace.

• Always generate documentation before starting deep refactoring tasks to ensure you have a clear picture of internal implementation details, optionally using --document-private-items.

• Refer to generated code examples found in doctest blocks to learn idiomatic usage patterns of HASH-specific crates.

• Note that documentation generation is workspace-aware; you can target specific crates using --package or document the entire workspace at once.

• Be aware that generated files are placed within the target directory; ensure you have sufficient disk space for large dependency graphs if not using --no-deps.

• This tool is specifically tailored for Rust-based development workflows within HASH and assumes a standard environment where cargo and rust toolchains are pre-configured.