RuleStack

Configs

Stacks

Compare

Diff

RuleStack

Configs

Stacks

Compare

Diff

Read API

RuleStack

Configs

Stacks

Compare

Diff

Read API

Configs/Cursor rules/hashintel/hash

Cursor rule

.cursor/rules/rust-documentation.mdc

Rust Documentation Practices

Cursor rules

Quality

33/100

Scores the file, not the repository.

Length

64 words

2 headings · 0 code blocks

Repository

1.6k

— · pushed 0 days ago

Last changed

3 days ago

First indexed 3 days ago.
hashintel/hash/.cursor/rules/rust-documentation.mdcRawGitHub
1---
2description: Rust Documentation Practices
3globs: "**/*.rs"
4alwaysApply: false
5---
6 
7# Rust Documentation Practices
8 
9Detailed documentation guidelines are maintained in:
10 
11- `.claude/skills/documenting-rust-code/SKILL.md` - Main guidelines
12- `.claude/skills/documenting-rust-code/resources/` - Detailed patterns
13 
14## Quick Reference
15 
16Key points:
17 
18- Begin doc comments with single-line summary
19- Use intra-doc links liberally: [`Vec`], [`HashMap`], etc.
20- Document errors with `# Errors` section
21- Include examples for public APIs with `# Examples`
22- Use `cargo doc --no-deps --all-features` to verify
23 

Commands it names

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

Sections

  • Rust Documentation Practices
  • Quick Reference

What it covers

docs

Stack — with the evidence

typescript

(1.00)

rust

(1.00)

node

(0.70)

react

(0.70)

nextjs

(0.70)

express

(0.70)

fastapi

(0.70)

llamaindex

(0.70)

vitest

(0.70)

pytest

(0.70)

eslint

(0.70)

vercel

(0.70)

aws

(0.70)

javascript

(0.60)

turborepo

(0.60)

monorepo

(0.60)

github-actions

(0.60)

python

(0.50)

Glob targeting

  • **/*.rs

Format

Cursor rules

The most expressive format here. Many small .mdc files, each with frontmatter declaring when it should load, so a rule about migrations only enters context when a migration is open. Costs the most to maintain and only one editor reads it.

What the corpus says about it

Repository

Owner
hashintel
Language
—
License
—
Archived
no

All configs in this repo

Also in hashintel/hash

Diff this repo’s formats

One repository carrying more than one format is the comparison this product exists for: does anyone actually write different content in each file, or is one a copy of the other?

The other instruction files in this repository
RepositoryFormatStackCoversScoreChanged
hashintel/hash.cursor/rules/ai-assistant-guidelines.mdc · 1.6kCursor rulestypescriptrust+16do-not51/1003 days ago
hashintel/hash.cursor/rules/git-commit-conventions.mdc · 1.6kCursor rulestypescriptrust+16lint-formatstylegitdo-not51/1003 days ago
hashintel/hash.cursor/rules/meaningful-identifiers.mdc · 1.6kCursor rulestypescriptrust+16do-not32/1003 days ago
hashintel/hash.cursor/rules/rust-coding-style.mdc · 1.6kCursor rulestypescriptrust+16lint-formatstyletypesdependencies+269/1003 days ago
hashintel/hash.cursor/rules/rust-error-handling.mdc · 1.6kCursor rulestypescriptrust+16no sections31/1003 days ago
hashintel/hash.cursor/rules/rust-testing-strategy.mdc · 1.6kCursor rulestypescriptrust+16testlint-formatstyletesting-strategy81/1003 days ago
hashintel/hash.cursor/rules/rust-tracing-practices.mdc · 1.6kCursor rulestypescriptrust+16no sections45/1003 days ago
hashintel/hash.cursor/rules/update-rules.mdc · 1.6kCursor rulestypescriptrust+16no sections4/1003 days ago
hashintel/hash.github/instructions/code-review.instructions.md · 1.6kCopilot instructionstypescriptrust+16lint-formatstylegitdo-not+178/1003 days ago
hashintel/hash.github/instructions/rust-review.instructions.md · 1.6kCopilot instructionstypescriptrust+16lint-formatstylegitdo-not73/1003 days ago
hashintel/hash.github/instructions/typescript-review.instructions.md · 1.6kCopilot instructionstypescriptrust+16testlint-formatstyletypes+266/1003 days ago
hashintel/hashAGENTS.md · 1.6kAGENTS.mdtypescriptrust+16testlint-formatarchtypes+493/1003 days ago
hashintel/hashlibs/@hashintel/ds-components/AGENTS.md · 1.6kAGENTS.mdtypescriptrust+18buildtestlint-formatstyle+597/1003 days ago
hashintel/hashlibs/@hashintel/ds-helpers/AGENTS.md · 1.6kAGENTS.mdtypescriptrust+16archdependenciesagent-behaviour62/1003 days ago
hashintel/hashlibs/@hashintel/petrinaut/AGENTS.md · 1.6kAGENTS.mdtypescriptrust+17buildtestlint-formatstyle80/1003 days ago
hashintel/hash.cursor/rules/typescript-coding-guidelines.mdc · 1.6kCursor rulestypescriptrust+16styletypesdo-not65/1003 days ago
Diff against .cursor/rules/ai-assistant-guidelines.mdc Diff against .cursor/rules/git-commit-conventions.mdc Diff against .cursor/rules/meaningful-identifiers.mdc Diff against .cursor/rules/rust-coding-style.mdc Diff against .cursor/rules/rust-error-handling.mdc Diff against .cursor/rules/rust-testing-strategy.mdc Diff against .cursor/rules/rust-tracing-practices.mdc Diff against .cursor/rules/update-rules.mdc Diff against .github/instructions/code-review.instructions.md Diff against .github/instructions/rust-review.instructions.md Diff against .github/instructions/typescript-review.instructions.md Diff against AGENTS.md Diff against libs/@hashintel/ds-components/AGENTS.md Diff against libs/@hashintel/ds-helpers/AGENTS.md Diff against libs/@hashintel/petrinaut/AGENTS.md Diff against .cursor/rules/typescript-coding-guidelines.mdc

Similar configs

Same format, overlapping stack, ranked by quality.

Same format, overlapping stack, ranked by quality
RepositoryFormatStackCoversScoreChanged
hiromaily/go-crypto-wallet.cursor/rules/typescript.mdc · 126Cursor rulesgobun+5setupbuildtestlint-format+6100/1003 days ago
TechSquidTV/Hermes.cursor/rules/10-hermes-api.mdc · 45Cursor rulestypescriptpytest+15testlint-formatstylearch+5100/1003 days ago
markstev/mark-starter.cursor/rules/frontend.mdc · 0Cursor rulestypescriptturborepo+14setuptestlint-formatstyle+699/1003 days ago
Allymahmoud/case-intake-platform.cursor/rules/frontend.mdc · 0Cursor rulestypescriptturborepo+13setuptestlint-formatstyle+799/1003 days ago
dodgecfr/combatfilms-webapp.cursor/rules/frontend.mdc · 0Cursor rulestypescriptturborepo+15setuptestlint-formatstyle+799/1003 days ago
deifos/clipmira-subtitles.cursor/rules/frontend.mdc · 1Cursor rulestypescriptnextjs+5setuptestlint-formatstyle+799/1003 days ago
TechSquidTV/Hermes.cursor/rules/20-hermes-api-tests.mdc · 45Cursor rulestypescriptpytest+15teststyletesting-strategysecurity+397/1003 days ago
langflow-ai/langflow.cursor/rules/docs_development.mdc · 153kCursor rulespythonnode+16setupbuildtestlint-format+797/1003 days ago
RuleStack

Built by

Kynth Studio

Directory

Configs
Stacks
Compare formats
Diff two configs
Best AGENTS.md examples

Formats

AGENTS.md
CLAUDE.md
Cursor rules
Copilot instructions

Reference

Read API
Corpus health
Privacy Policy
Terms

RuleStack

RuleStack

Built by

Kynth Studio

Directory

Configs
Stacks
Compare formats
Diff two configs
Best AGENTS.md examples

Formats

AGENTS.md
CLAUDE.md
Cursor rules
Copilot instructions

Reference

Read API
Corpus health
Privacy Policy
Terms

RuleStack

RuleStack

Built by

Kynth Studio

Directory

Configs
Stacks
Compare formats
Diff two configs
Best AGENTS.md examples

Formats

AGENTS.md
CLAUDE.md
Cursor rules
Copilot instructions

Reference

Read API
Corpus health
Privacy Policy
Terms

RuleStack