Agent skill

Documenting Rust Code

Rust documentation practices for HASH codebase. An agent skill from hashintel/hash.

AGPL-3.0Auto-check passedDevelopment

Install Documenting Rust Code

skills CLI

$ npx skills add hashintel/hash --skill documenting-rust-code -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI

$ gh skill install hashintel/hash documenting-rust-code --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy

$ git clone --depth 1 https://github.com/hashintel/hash.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/documenting-rust-code .claude/skills/documenting-rust-code && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Paste into Claude Code

Install the "documenting-rust-code" agent skill from https://github.com/hashintel/hash/tree/main/.agents/skills/documenting-rust-code into .claude/skills/documenting-rust-code/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documenting-rust-code", then confirm the skill loads.

Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

$skill-installer

$skill-installer install https://github.com/hashintel/hash/tree/main/.agents/skills/documenting-rust-code

Type this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.

skills CLI

$ npx skills add hashintel/hash --skill documenting-rust-code -a codex

Project install goes to .agents/skills/; add -g for ~/.codex/skills/.

GitHub CLI

$ gh skill install hashintel/hash documenting-rust-code --agent codex

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/hashintel/hash.git skills-src && mkdir -p .agents/skills && cp -r skills-src/.agents/skills/documenting-rust-code .agents/skills/documenting-rust-code && rm -rf skills-src

Use ~/.agents/skills/ instead of .agents/skills for a personal install.

Codex skills documentation · loads skills from .agents/skills/

Paste into Codex

Install the "documenting-rust-code" agent skill from https://github.com/hashintel/hash/tree/main/.agents/skills/documenting-rust-code into .agents/skills/documenting-rust-code/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documenting-rust-code", then confirm the skill loads.

Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

skills CLI

$ npx skills add hashintel/hash --skill documenting-rust-code -a cursor

Project install goes to .agents/skills/; add -g for ~/.cursor/skills/.

GitHub CLI

$ gh skill install hashintel/hash documenting-rust-code --agent cursor

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/hashintel/hash.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/.agents/skills/documenting-rust-code .cursor/skills/documenting-rust-code && rm -rf skills-src

Use ~/.cursor/skills/ instead of .cursor/skills for a personal install.

Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/

Paste into Cursor

Install the "documenting-rust-code" agent skill from https://github.com/hashintel/hash/tree/main/.agents/skills/documenting-rust-code into .cursor/skills/documenting-rust-code/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documenting-rust-code", then confirm the skill loads.

Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

gemini skills install

$ gemini skills install https://github.com/hashintel/hash.git --path .agents/skills/documenting-rust-code

--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.

skills CLI

$ npx skills add hashintel/hash --skill documenting-rust-code -a gemini-cli

Project install goes to .agents/skills/; add -g for ~/.gemini/skills/.

GitHub CLI

$ gh skill install hashintel/hash documenting-rust-code --agent gemini-cli

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/hashintel/hash.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/.agents/skills/documenting-rust-code .gemini/skills/documenting-rust-code && rm -rf skills-src

Use ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.

Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/

Paste into Gemini CLI

Install the "documenting-rust-code" agent skill from https://github.com/hashintel/hash/tree/main/.agents/skills/documenting-rust-code into .gemini/skills/documenting-rust-code/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documenting-rust-code", then confirm the skill loads.

Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

GitHub CLI

$ gh skill install hashintel/hash documenting-rust-code

Installs for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).

skills CLI

$ npx skills add hashintel/hash --skill documenting-rust-code -a github-copilot

Project install goes to .agents/skills/; add -g for ~/.copilot/skills/.

Manual copy

$ git clone --depth 1 https://github.com/hashintel/hash.git skills-src && mkdir -p .github/skills && cp -r skills-src/.agents/skills/documenting-rust-code .github/skills/documenting-rust-code && rm -rf skills-src

Use ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.

GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/

Paste into GitHub Copilot

Install the "documenting-rust-code" agent skill from https://github.com/hashintel/hash/tree/main/.agents/skills/documenting-rust-code into .github/skills/documenting-rust-code/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documenting-rust-code", then confirm the skill loads.

GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

skills CLI

$ npx skills add hashintel/hash --skill documenting-rust-code -a opencode

OpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.

GitHub CLI

$ gh skill install hashintel/hash documenting-rust-code --agent opencode

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/hashintel/hash.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/.agents/skills/documenting-rust-code .opencode/skills/documenting-rust-code && rm -rf skills-src

Use ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.

OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/

Paste into OpenCode

Install the "documenting-rust-code" agent skill from https://github.com/hashintel/hash/tree/main/.agents/skills/documenting-rust-code into .opencode/skills/documenting-rust-code/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documenting-rust-code", then confirm the skill loads.

OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

Facts

Skill name: documenting-rust-code
GitHub stars: 1.7k
Token cost: ~1.1k tokens
SKILL.md length: 170 words
Files: 5 (incl. references)
Skills in repo: 17
Repo updated: Oct 7, 2026
First seen: Oct 7, 2026
Licence: AGPL-3.0

At a glance

Rust documentation practices for HASH codebase. An agent skill from hashintel/hash.

Writing doc comments
SKILL.md covers Core Principles, Quick Reference, Documentation Patterns and Verification, plus 1 more section
Calls cargo
Documenting functions/types/traits/modules

What it does

Documenting Rust Code is an agent skill from hashintel/hash. 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.

Its SKILL.md is about 1.1k tokens, which your agent loads only when the skill is triggered. The skill folder holds 5 other files, including reference files (for example `references/error-documentation.md`, `references/examples-and-links.md` and `references/function-documentation.md`).

It sits in Development. It works with Rust. The repository describes itself as: 🚀 The open-source, multi-tenant platform for self-building knowledge graphs and simulation. The licence is AGPL-3.0.

When your agent uses it

Writing doc comments
Documenting functions/types/traits/modules
Creating error sections
Using intra-doc links

Example prompts

“/documenting-rust-code”

What it can do on your machine

Read from SKILL.md and the folder at commit e189ab2. It shows what the files ask for, not the result of running them.

Tool permissions
Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.
From allowed-tools in the SKILL.md frontmatter.
Runs code
Shell commands in SKILL.md call:
- cargo
From the folder's file list and the shell code blocks in SKILL.md.
Network
No URLs in SKILL.md.
From URLs in SKILL.md, links to its own repository left out.
Credentials
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Documenting Rust Code loads about 1.1k tokens when it runs, and up to ~7.2k if it reads all its reference files. Until then it costs about 57 tokens; SKILL.md has 170 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it: ~57
When it runs · the whole SKILL.md, loaded when a task matches: ~1.1k
With references · SKILL.md plus every file in references/, read only if the agent opens them: ~7.2k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from hashintel/hash at commit e189ab2, republished under its AGPL-3.0 licence (© hashintel). 170 words, ~1,065 tokens.

Download SKILL.mdSave it as .claude/skills/documenting-rust-code/SKILL.md (or your agent's skills folder). This skill also uses 4 other files; get the full folder from GitHub.

name: documenting-rust-code
description: 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.
license: AGPL-3.0

Rust Documentation Practices

Comprehensive guidance on documenting Rust code in the HASH repository following rustdoc conventions.

Core Principles

Follow high-quality standards like time, jiff, and serde:

✅ DO:

Begin every doc comment with single-line summary
Use intra-doc links for all type references
Document all error conditions with # Errors
Include practical examples for public APIs
Link standard library types: [Vec], [HashMap], etc.
Use inline parameter descriptions for simple functions (0-2 params)
Describe return values in main text, not separate sections

❌ DON'T:

Document standard trait implementations (Debug, Display, From)
Add separate # Returns sections (inline instead)
Mention variable types already in signatures
Use comments on same line as code
Skip error documentation for fallible functions

Quick Reference

Basic Doc Comment

rust

/// Retrieves an entity by its UUID.
///
/// Loads the entity from the store and verifies access permissions.
/// Returns the [`Entity`] if found and accessible.
///
/// # Errors
///
/// - [`NotFound`] if the entity doesn't exist
/// - [`AuthorizationError`] if access is denied
///
/// [`NotFound`]: EntityError::NotFound
/// [`AuthorizationError`]: EntityError::Authorization
pub fn get_entity(&self, id: EntityId) -> Result<Entity, Report<EntityError>> {

Intra-Doc Links

rust

/// Updates the [`User`] using [`UserUpdateStrategy`].
///
/// See [`validation::user`] for validation rules.
///
/// [`validation::user`]: crate::validation::user

Documentation Patterns

Simple Functions (0-2 params)

Describe parameters inline:

rust

/// Processes the `input` elements and returns filtered results.
///
/// Takes a collection of `input` elements, applies the `filter_fn`,
/// and returns a [`Vec`] containing only matching elements.

Complex Functions (3+ params)

Use explicit # Arguments section:

rust

/// Merges multiple data sources with transformation rules.
///
/// # Arguments
///
/// * `sources` - Collection of data sources to merge
/// * `rules` - Transformation rules to apply
/// * `options` - Configuration controlling merge behavior
/// * `callback` - Optional function for each merged item

Error Documentation

rust

/// # Errors
///
/// - [`WebAlreadyExists`] if web ID is taken
/// - [`AuthorizationError`] if permission denied
///
/// [`WebAlreadyExists`]: WebError::WebAlreadyExists
/// [`AuthorizationError`]: WebError::Authorization

Module Documentation

rust

//! Entity management functionality.
//!
//! Main types:
//! - [`Entity`] - Core entity type
//! - [`EntityStore`] - Storage trait
//!
//! # Examples
//!
//! ```
//! use hash_graph::entity::Entity;
//! ```

Examples with Error Handling

rust

/// # Examples
///
/// ```rust
/// let entities = get_entities_by_type(type_id)?;
/// assert_eq!(entities.len(), 2);
/// # Ok::<(), Box<dyn core::error::Error>>(())
/// ```

Verification

bash

cargo doc --no-deps --all-features

References

references/function-documentation.md: Functions and methods documentation patterns
references/type-documentation.md: Types, structs, enums, and traits documentation
references/error-documentation.md: Error conditions and panics documentation
references/examples-and-links.md: Examples and intra-doc links usage

Files

SKILL.md and 4 other files (references) in .agents/skills/documenting-rust-code of hashintel/hash.

SKILL.md
references/error-documentation.md
references/examples-and-links.md
references/function-documentation.md
references/type-documentation.md

Open the folder on GitHubat commit e189ab2

Compare with similar skills

Documenting Rust Code next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Documenting Rust Code compared with similar skills
Skill	Stars	Used in	Tokens	Auto-check	Licence	Repo updated
Documenting Rust Code this skillhashintel/hash	1.7k	—	~1.1k	Automated safety check: Pass	AGPL-3.0	today
Migrate Core Code to Submodulestinyhumansai/openhuman	41k	—	~2.6k	Automated safety check: Pass	GPL-3.0	today
Rust Best Practicesfarm-fe/farm	5.6k	3 repos	~1.1k	Automated safety check: Pass	MIT	15 days ago
OpenLogi macOS Permissions TriageAprilNEA/OpenLogi	23k	—	~2.5k	Automated safety check: Notes	Apache-2.0	3 days ago
RTK Rust Design Patternsrtk-ai/rtk	83k	—	~1.9k	Automated safety check: Pass	Apache-2.0	today
Release Skillsnexmoe/eve	421	3 repos	~3.3k	Automated safety check: Pass	None	6 mo ago

Similar skills

Migrate Core Code to Submodules
tinyhumansai/openhuman
Plans and carries out moving non-host-specific code and its tests from the OpenHuman core into vendored tiny submodule libraries, then releases the submodule and re-pins the host.
41k GitHub stars~2.6k tokensUpdated today
DevelopmentAuto-check passed
Rust Best Practices
farm-fe/farm
Guide for writing idiomatic Rust code based on Apollo GraphQL's best practices handbook.
5.6k GitHub starsUsed in 3 repos~1.1k tokens
DevelopmentAuto-check passed
OpenLogi macOS Permissions Triage
AprilNEA/OpenLogi
Decides whether an OpenLogi device problem on macOS is a privacy-permission (TCC) problem, using agent log lines, and says which identity needs which grant.
23k GitHub stars~2.5k tokensUpdated 3 days ago
DevelopmentAuto-check: notes
RTK Rust Design Patterns
rtk-ai/rtk
Describes seven Rust design patterns for the RTK CLI filter modules, with when to use each, RTK examples, and notes on when a pattern is overkill.
83k GitHub stars~1.9k tokensUpdated today
DevelopmentAuto-check passed
Release Skills
nexmoe/eve
Universal release workflow. An agent skill from nexmoe/eve.
421 GitHub starsUsed in 3 repos~3.3k tokens
DevelopmentAuto-check passed
Pnpm Engine
teambit/bit
Work on the pnpm Rust engine (@pnpm/napi, the pacquet crates) that bit install runs through.
18k GitHub stars~1.9k tokensUpdated today
DevelopmentAuto-check passed

Questions about Documenting Rust Code

What does Documenting Rust Code do?

Rust documentation practices for HASH codebase. An agent skill from hashintel/hash. Documenting Rust Code is an agent skill from hashintel/hash. Rust documentation practices for HASH codebase.

When should I use Documenting Rust Code?

Documenting Rust Code fits situations like: writing doc comments; documenting functions/types/traits/modules; creating error sections; using intra-doc links.

How do I install Documenting Rust Code in Claude Code?

Run `npx skills add hashintel/hash --skill documenting-rust-code -a claude-code`. Or copy the skill folder (.agents/skills/documenting-rust-code in hashintel/hash) into .claude/skills/documenting-rust-code in your project. Claude Code loads it when a task matches its description.

How do I install Documenting Rust Code in Codex?

Run `npx skills add hashintel/hash --skill documenting-rust-code -a codex`. Or copy the skill folder (.agents/skills/documenting-rust-code in hashintel/hash) into .agents/skills/documenting-rust-code in your project. Codex loads it when a task matches its description.

Can I use Documenting Rust Code in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add hashintel/hash --skill documenting-rust-code -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/documenting-rust-code, .gemini/skills/documenting-rust-code, .github/skills/documenting-rust-code and .opencode/skills/documenting-rust-code in your project.

What does Documenting Rust Code need to run?

Going by SKILL.md and its folder, Documenting Rust Code needs the command-line tools its instructions call (cargo).

Does Documenting Rust Code access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Documenting Rust Code safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Documenting Rust Code use?

Documenting Rust Code is published under the AGPL-3.0 licence (declared in SKILL.md). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Documenting Rust Code use?

About 1.1k tokens (SKILL.md is roughly 4.3k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 6.1k tokens, read only when the agent opens those files.

What are the alternatives to Documenting Rust Code?

Skills that share tags, products or a category with Documenting Rust Code: Migrate Core Code to Submodules (tinyhumansai/openhuman, 41k stars), Rust Best Practices (farm-fe/farm, 5.6k stars), OpenLogi macOS Permissions Triage (AprilNEA/OpenLogi, 23k stars) and RTK Rust Design Patterns (rtk-ai/rtk, 83k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Documenting Rust Code?

hashintel (a GitHub organization) maintains it in hashintel/hash, which has 1,668 GitHub stars. The repository holds 17 skills in this directory. The repository was last updated on October 7, 2026.

Source: hashintel/hash on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.

Install Documenting Rust Code

Facts

At a glance

What it does

When your agent uses it

Example prompts

What it can do on your machine

Tool permissions

Runs code

Network

Credentials

Context cost

Safety

SKILL.md

Rust Documentation Practices

Core Principles

Quick Reference

Basic Doc Comment

Intra-Doc Links

Documentation Patterns

Simple Functions (0-2 params)

Complex Functions (3+ params)

Error Documentation

Module Documentation

Examples with Error Handling

Verification

References

Files

Compare with similar skills

Similar skills

More from hashintel/hash

Related

Questions about Documenting Rust Code