metamask-docs / rules
Cursor rule865 starsChanged 16 days agoApache-2.0View on GitHub
Product-specific guidance for Snaps documentation, including naming, content areas, and generated-content constraints.
We split this product-snaps.mdc into the rules it gives an agent
1 rule. About 0 are common, 1 is distinctive, and 0 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈1
Distinctive · estimate
This author's own choices. Worth a look.
0
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 13
Do not use lowercase "snaps" or "snap" in prose (only in code identifiers or file paths).
≈ “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.
Files
--- description: Product-specific guidance for Snaps documentation, including naming, content areas, and generated-content constraints. globs: snaps/**/*.md,snaps/**/*.mdx alwaysApply: false --- # Snaps ## Naming - **Snaps** (capital S) refers to the platform or ecosystem. - **a Snap** (capital S, singular) refers to an individual extension. - Do not use lowercase "snaps" or "snap" in prose (only in code identifiers or file paths). ## Content areas Snaps uses a content structure that differs slightly from other products: | Folder | Type | Description | |-----------------|-----------------------|-----------------------------------------------| | `learn/` | Explanation | Conceptual content, best practices, tutorials | | `how-to/` | How-to | Procedural step-by-step guides | | `features/` | Feature reference | Feature-centric documentation | | `reference/` | API reference | Snaps API and Keyring API methods | | `get-started/` | Onboarding | First-time setup and onboarding | ## Generated reference pages Reference pages under `snaps/reference/snaps-api/` are **generated** from a JSON schema by the `plugin-snaps-docs.ts` build plugin. Do not edit these files directly. To update their content, edit the source schema or the plugin in `src/plugins/plugin-snaps-docs.ts`. ## Experimental features The `flaskOnly` admonition keyword is available in Snaps docs for features that require MetaMask Flask. Use it like any other admonition: ```markdown :::flaskOnly This feature is experimental and only available in MetaMask Flask. ::: ``` ## Sidebar The sidebar configuration is in [snaps-sidebar.js](snaps-sidebar.js).
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/markdown-formatting.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/terminology.mdcCursor rule
- .cursor/rules/vercel-redirects.mdcCursor rule
- static/llms.txtllms.txt
- author-pageSkill
- style-reviewSkill
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.