mintlifymintlify/docs/.cursor/rules/writing-standards.mdc

docs / rules

Cursor rule457 starsChanged 30 days agoMITView on GitHub

Writing and style standards for Mintlify documentation

We split this writing-standards.mdc into the rules it gives an agent

3 rules. About 0 are common, 0 are distinctive, and 3 are 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.
3
Very specific
Tied to their project's names, files or tools. Probably skip.

Common
Distinctive
Very specific

Very specific:
Run mint broken-links to check internal links.
line 15
Very specific:
Run mint a11y to check for accessibility issues.
line 16
Very specific:
Run vale $(git diff --name-only main) to check style and spelling.
line 18

≈ “Common” is an estimate: at least 1 in 5 of the 6,350 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.

Keep what fits and drop the rest. Your version, ready for your agents.

Files

writing-standards.mdc

---
description: Writing and style standards for Mintlify documentation
globs:
alwaysApply: true
---
# Mintlify documentation writing standards

Before you write or edit content, read `style-guide/README.md` and the style guide files relevant to your change. The style guide is the source of truth for voice, tone, terminology, formatting, component usage, and content strategy. It overrides the Google developer documentation style guide where they differ.

For component syntax, see `component-reference.mdc` or the pages in `components/`.

## Before publishing

- Preview changes locally with `mint dev`.
- Run `mint broken-links` to check internal links.
- Run `mint a11y` to check for accessibility issues.
- Manually test external links to make sure they don't 404.
- Run `vale $(git diff --name-only main)` to check style and spelling.

Download now (ZIP)

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 3,978 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 repository8 other files it gives its agents.
- .mintlify/AGENTS.mdAGENTS.md
- .claude/CLAUDE.mdCLAUDE.md
- .cursor/rules/component-reference.mdcCursor rule
- doc-authorSkill
- doc-readerSkill
- mintlifySkill
- mintlifySkill
- mintlify-apiSkill

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

Reviews can't be read right now.

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.

Check your setup, free