tamirs-superpowers / rules
Cursor rule2 starsChanged 3 months agoMITView on GitHub
Human-facing docs end with the canonical two-link footer; every diagram is a Mermaid block opening with the canonical dark init line. Canonical: rules/dev/documentation-standards.md
Where files are headingNew Cursor rule files have more rules about planning and tracking tasks, and fewer about code style.
Of the Cursor rule files we read, the 4,183 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repository46 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- .cursor/rules/commit-conventions.mdcCursor rule
- .cursor/rules/cross-platform-handoff.mdcCursor rule
- .cursor/rules/dev-files-workspace.mdcCursor rule
- .cursor/rules/gh-cli-preference.mdcCursor rule
- .cursor/rules/github-repository-policy.mdcCursor rule
- .cursor/rules/git-worktree-agent-workflow.mdcCursor rule
- .cursor/rules/hooks-guide.mdcCursor rule
- .cursor/rules/plugin-structure.mdcCursor rule
- .cursor/rules/plugin-version-bump.mdcCursor rule
- .cursor/rules/skill-frontmatter.mdcCursor rule
- .cursor/rules/skill-quality-standards.mdcCursor rule
- .cursor/rules/skills-guide.mdcCursor rule
- .cursor/rules/user-facing-script-standards.mdcCursor rule
- run-tamirs-superpowersSkill
- field-notebook-uiSkill
- diagnose-refusalSkill
- targeted-debugSkill
- decisionSkill
- deliver-devSkill
- diagnose-objectiveSkill
- orchestrate-devSkill
- plan-devSkill
- pr-devSkill
- start-devSkill
- switch-devSkill
- worker-devSkill
- changelog-reviewSkill
- dark-terminal-docSkill
- docs-reviewSkill
- platform-syncSkill
- mcp-builderSkill
- mcp-paginationSkill
- cleanupSkill
- github-policySkill
- multi-agent-repoSkill
- repo-scaffoldSkill
- repo-standardsSkill
- capture-configSkill
- find-skillSkill
- notify-setupSkill
- retroSkill
- session-reportSkill
- skill-creatorSkill
- usage-captureSkill
The file
We split this documentation-standards.mdc into the rules it gives an agent
1 rule. About 0 are common, 0 are distinctive, and 1 is very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈0
Distinctive · estimate
This author's own choices. Worth a look.
1
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 18
Never type the footer: bash scripts/check-doc-standards.sh --fix appends or repairs it from the config.
≈ “Common” is an estimate: at least 1 in 5 of the 6,668 Cursor rule files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
---
description: "Human-facing docs end with the canonical two-link footer; every diagram is a Mermaid block opening with the canonical dark init line. Canonical: rules/dev/documentation-standards.md"
alwaysApply: false
globs: ["README.md", "docs/**/*.md", "config/docs/**/*", "scripts/check-doc-standards.sh"]
---
<!-- GENERATED FILE — DO NOT EDIT.
Source: rules/dev/documentation-standards.md (frontmatter + summary: platforms/cursor/rules.map.json)
Generator: scripts/build-cursor-rules.sh
Regenerate: make cursor-rules -->
# Documentation standards
Canonical rule: `rules/dev/documentation-standards.md`. The data — human-facing globs, footer URLs, the init line — lives in `config/docs/`; never restate it.
- **Every diagram is a fenced ```mermaid block**, never box-drawing or ASCII art (a directory tree in a ```text fence is not a diagram). Its first line is the canonical init directive from `config/docs/mermaid-init.txt`, copied verbatim; no `classDef` / `class` / `style` / `fill:` inside a block. Dark is the default; one block may keep another palette when the line above its fence reads `<!-- doc-standards-ok: <reason> -->`.
- **Every human-facing doc** (`README.md`, `docs/**` minus `docs/agent-guidelines/**`, `docs/changelog/**`, `docs/CHANGELOG.md`) **ends with the same centred footer**: a `---` rule, then one `<p align="center">` with `Have a Question?` and `Open an Issue` separated by ` · `. `README.md` keeps its `MIT © …` line directly above it.
- Never type the footer: `bash scripts/check-doc-standards.sh --fix` appends or repairs it from the config. `make check-doc-standards` (in `make validate`) fails on any violation; `--strict` also flags box-drawing lines.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.