exploring-rust-crates
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.
Installation
Pick a client and clone the repository into its skills directory.
Installation
About this skill
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.
How to use
Otwórz terminal w katalogu workspace HASH i upewnij się, że masz zainstalowany Rust oraz cargo.
Uruchom polecenie generujące dokumentację dla konkretnego cratea, zastępując
rzeczywistą nazwą: cargo doc --no-deps --all-features --package . Flaga --no-deps dokumentuje tylko lokalny kod (szybciej), --all-features uwzględnia wszystkie warianty API, a --package wskazuje konkretny crate. Jeśli chcesz wygenerować dokumentację dla całego workspace, użyj: cargo doc --no-deps --all-features --workspace.
Poczekaj na zakończenie procesu generowania. Dokumentacja zostanie zapisana w katalogu target/doc/
/index.html. Otwórz wygenerowany plik index.html w przeglądarce, aby przeglądać hierarchię modułów, publiczne funkcje, typy, traity, przykłady użycia i dokumentację błędów.
Jeśli potrzebujesz zobaczyć także prywatne elementy implementacji, dodaj flagę --document-private-items do polecenia cargo doc.