metamask-docs / rules

We split this markdown-formatting.mdc into the rules it gives an agent

18 rules. About 0 are common, 5 are distinctive, and 13 are very specific to this project.

• ≈0

  Common · estimate

  Many files like this have a rule of this kind.

• ≈5

  Distinctive · estimate

  This author's own choices. Worth a look.

• 13

  Very specific

  Tied to their project's names, files or tools. Probably skip.

• Common
• Distinctive
• Very specific

1. Distinctive:

   Follow the Consensys Markdown formatting guide for full details.

   line 9
2. Distinctive:

   Start each new sentence on a new line, even if the previous line is short.

   line 15
3. Very specific:

   Use relative file paths for links within the same product (for example, ./concepts/scopes.md).

   line 20
4. Very specific:

   Use absolute URL paths for cross-product links (for example, /snaps/learn/about-snaps).

   line 21
5. Distinctive:

   Use descriptive link text.

   line 22
6. Very specific:

   Use absolute links on CardList components.

   line 23
7. Very specific:

   Always specify the language on fenced code blocks ( javascript , bash , etc.).

   line 27
8. Very specific:

   After editing documentation, run npm run format so Prettier applies these rules to fenced code in Markdown/MDX (see .prettierrc).

   line 33
9. Very specific:

   Write code samples that can be copied, pasted, and run as-is.

   line 36
10. Very specific:

    Use angle-bracket placeholders for values the reader must supply (for example, <YOUR_INFURA_API_KEY>).

    line 38
11. Very specific:

    Use Docusaurus <Tabs> and <TabItem> components to display parallel content such as code samples in different languages or package-manager …

    line 43
12. Very specific:

    Import Tabs and TabItem from @theme/Tabs and @theme/TabItem at the top of the file.

    line 45
13. Very specific:

    Use Docusaurus admonitions: :::note, :::tip, :::caution, :::info, :::danger.

    line 49
14. Very specific:

    Add a custom title on the same line only when it helps scanning (for example, :::caution important).

    line 50
15. Distinctive:

    Do not nest admonitions.

    line 51
16. Distinctive:

    Use a tool like Markdown Table Formatter if needed.

    line 56
17. Very specific:

    If the frontmatter contains a title field, do not add a separate top-level # Heading to avoid a duplicate H1.

    line 64
18. Very specific:

    Use lowercase letters and dashes only (for example, send-transactions.md, not sendTransactions.md).

    line 69

≈ “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.

• 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 repository15 other files it gives its agents.

  • AGENTS.mdAGENTS.md
  • .cursor/rules/content-types.mdcCursor rule
  • .cursor/rules/contributor-workflow.mdcCursor rule
  • .cursor/rules/editorial-voice.mdcCursor rule
  • .cursor/rules/product-agent-wallet.mdcCursor rule
  • .cursor/rules/product-embedded-wallets.mdcCursor rule
  • .cursor/rules/product-infura.mdcCursor rule
  • .cursor/rules/product-metamask-connect.mdcCursor rule
  • .cursor/rules/product-smart-accounts-kit.mdcCursor rule
  • .cursor/rules/product-snaps.mdcCursor rule
  • .cursor/rules/terminology.mdcCursor rule
  • .cursor/rules/vercel-redirects.mdcCursor rule
  • static/llms.txtllms.txt
  • author-pageSkill
  • style-reviewSkill