documenting-rust-code
Description
Rust documentation practices for HASH codebase.
How to Use
- Visit the GitHub repository to get the SKILL.md file
- Copy the file to your project root or .cursor/rules directory
- Restart your AI assistant or editor to apply the new skill
Full Skill Documentation
name
documenting-rust-code
description
Rust documentation practices for HASH codebase. Use when writing doc comments, documenting functions and types, creating error documentation sections, using intra-doc links, documenting traits and modules, writing examples, or following rustdoc conventions.
Tags
Related Skills
internal-comms
A set of resources to help write internal communications like status reports, leadership updates, newsletters, FAQs, and incident reports.
openapi-spec-generation
Generate and maintain OpenAPI 3.1 specifications from code, design-first specs, and validation patterns.
content-research-writer
Assists in writing high-quality content by conducting research, adding citations, improving hooks, and iterating on outlines.
docs-review
Review documentation changes for compliance with the Metabase writing style guide.
coding-tutor
Personalized coding tutorials that build on your existing knowledge and use your actual codebase for examples.