lang-rust-docs-dev

Rust documentation for modules and crate APIs should use inline doc comments, intra-doc links, and proper Errors sections. This Skill enforces those rustdoc standards to ensure documentation consistency across the HASH codebase.

Intra-doc links in Rust doc comments connect your documentation to specific types and traits automatically. This Skill provides guidelines for applying intra-doc links and reference patterns correctly across your crate APIs.

Documenting Errors sections in Rust libraries requires detailing failure conditions within your doc comments. This Skill enforces proper Errors section standards, ensuring crate APIs clearly communicate potential failures to users.

You can generate Rust documentation using cargo doc, then apply repository references to update code comments. This Skill aligns your inline docs and examples with cargo doc outputs to maintain quality standards.

These Rust documentation standards target the HASH codebase specifically, guiding modules, types, traits, and crate APIs. The rules focus on intra-doc links and error sections described in the repository references.

Inconsistent Rust doc comments occur when documentation lacks enforced standards for intra-doc links and error sections. This Skill solves that problem by detailing rustdoc conventions to improve consistency across the codebase.