Skip to content

Commit 5b4e5ba

Browse files
Merge branch 'MetaMask:main' into main
2 parents d5e3a6e + 3048eac commit 5b4e5ba

350 files changed

Lines changed: 8767 additions & 4435 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.cursor/rules/content-types.mdc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description: Maps folder conventions to Diataxis content types so AI tools produce the right structure for each doc category.
3-
globs: ["**/*.md", "**/*.mdx"]
3+
globs: **/*.md,**/*.mdx
44
alwaysApply: false
55
---
66

.cursor/rules/contributor-workflow.mdc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,12 @@ Pull requests run **`npm run format:check`** (Prettier against `.prettierrc` and
6969
**`npm run format`** locally to fix style before pushing. Generated Snaps API pages under
7070
`snaps/reference/snaps-api/` are excluded from formatting in git (see `.prettierignore`).
7171

72+
After **`npm install`**, [Husky](https://typicode.github.io/husky/) installs a Git **`pre-commit`** hook
73+
that runs [**`lint-staged`**](https://github.com/lint-staged/lint-staged) using the rules in
74+
`package.json`. Staged files matching those patterns are auto-formatted with Prettier (and other
75+
commands in `lint-staged`, such as ESLint on `src/`). Restage if the hook edits files. Hooks are
76+
local only and are not required for CI to pass.
77+
7278
Pull requests are checked by a Vale-based linter
7379
([docs-spelling-check](https://github.com/Consensys/github-actions/tree/main/docs-spelling-check))
7480
that enforces Microsoft style, Consensys terminology, and spelling. Fix any linter warnings before

.cursor/rules/editorial-voice.mdc

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description: Editorial voice and tone rules aligned with the Microsoft Writing Style Guide and Consensys documentation standards.
3-
globs: ["**/*.md", "**/*.mdx"]
3+
globs: **/*.md,**/*.mdx
44
alwaysApply: false
55
---
66

@@ -44,12 +44,14 @@ The rules below are the most actionable subset for AI-assisted editing.
4444

4545
## Punctuation and formatting
4646

47-
- Do not use em dashes or en dashes. Use commas, parentheses, semicolons, or rephrase the sentence.
47+
- Do not use em dashes (—) to set off extra information. Use commas, parentheses, semicolons, or rephrase the sentence.
4848
- Use only one space after periods, question marks, and colons.
4949
- Use sentence case for all headings and titles. Never use title case.
5050
- Do not end headings, subheadings, or UI titles with periods.
5151
- Use backticks for inline code, file names, and URLs referenced in prose.
52-
- Use bold for UI element names (buttons, menu items, field labels).
52+
- In general, do not use bold to emphasize words in a paragraph. Use bold sparingly:
53+
- For UI element names (buttons, menu items, field labels).
54+
- For emphasis in exceptional cases such as critical security warnings when an admonition is not enough.
5355

5456
## Developer content
5557

.cursor/rules/markdown-formatting.mdc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description: Markdown formatting conventions for the MetaMask documentation site (Docusaurus).
3-
globs: ["**/*.md", "**/*.mdx"]
3+
globs: **/*.md,**/*.mdx
44
alwaysApply: false
55
---
66

.cursor/rules/product-embedded-wallets.mdc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description: Product-specific guidance for Embedded Wallets documentation, including naming, content organization, and SDK conventions.
3-
globs: ["embedded-wallets/**/*.md", "embedded-wallets/**/*.mdx"]
3+
globs: embedded-wallets/**/*.md,embedded-wallets/**/*.mdx
44
alwaysApply: false
55
---
66

.cursor/rules/product-metamask-connect.mdc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description: Product-specific guidance for MetaMask Connect documentation, including terminology, CAIP standards, and content organization.
3-
globs: ["metamask-connect/**/*.md", "metamask-connect/**/*.mdx"]
3+
globs: metamask-connect/**/*.md,metamask-connect/**/*.mdx
44
alwaysApply: false
55
---
66

.cursor/rules/product-services.mdc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description: Product-specific guidance for Services (Infura) documentation, including naming, reference conventions, and partial reuse.
3-
globs: ["services/**/*.md", "services/**/*.mdx"]
3+
globs: services/**/*.md,services/**/*.mdx
44
alwaysApply: false
55
---
66

.cursor/rules/product-smart-accounts-kit.mdc

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
11
---
22
description: Product-specific guidance for Smart Accounts Kit documentation, including terminology, delegation concepts, glossary/tooltips, and versioning.
3-
globs:
4-
[
5-
'smart-accounts-kit/**/*.md',
6-
'smart-accounts-kit/**/*.mdx',
7-
'src/lib/glossary.json',
8-
'scripts/generate-smart-accounts-glossary.js',
9-
]
3+
globs: smart-accounts-kit/**/*.md,smart-accounts-kit/**/*.mdx,src/lib/glossary.json
104
alwaysApply: false
115
---
126

.cursor/rules/product-snaps.mdc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description: Product-specific guidance for Snaps documentation, including naming, content areas, and generated-content constraints.
3-
globs: ["snaps/**/*.md", "snaps/**/*.mdx"]
3+
globs: snaps/**/*.md,snaps/**/*.mdx
44
alwaysApply: false
55
---
66

.cursor/rules/terminology.mdc

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description: Required spelling and casing for product names, industry terms, and standards referenced across MetaMask documentation.
3-
globs: ["**/*.md", "**/*.mdx"]
3+
globs: **/*.md,**/*.mdx
44
alwaysApply: false
55
---
66

@@ -9,18 +9,19 @@ alwaysApply: false
99
Use the terms below consistently. The left column is the required form. Do not use the variants
1010
listed on the right unless they appear in code, URLs, or direct quotations from a specification.
1111

12-
| Required term | Do not use |
13-
|----------------------------------------|---------------------------------------------------------|
14-
| dapp | DApp, Dapp, dApp, decentralized application |
15-
| MetaMask | Metamask, metamask (except in code/URLs) |
16-
| smart account | smart contract account, SCA (unless quoting an ERC) |
17-
| externally owned account (EOA) | externally-owned account |
18-
| Snaps (platform) | snaps, SNAPS |
19-
| a Snap (singular) | a snap, a SNAP |
20-
| web3 | Web3, WEB3 (capitalize only at sentence start) |
21-
| sign in / sign out (verb) | log in, log out, login, logout (as verbs) |
22-
| sign-in / sign-out (noun or adjective) | log-in, log-out, login, logout (as nouns/adj) |
23-
| onchain / offchain | on-chain, off-chain |
12+
| Required term | Do not use |
13+
| -------------------------------------- | ------------------------------------------------------------------------------- |
14+
| dapp | DApp, dApp, decentralized application, Dapp (capitalize only at sentence start) |
15+
| MetaMask | Metamask, metamask (except in code/URLs) |
16+
| smart account | smart contract account, SCA (unless quoting an ERC) |
17+
| externally owned account (EOA) | externally-owned account |
18+
| Snaps (platform) | snaps, SNAPS |
19+
| a Snap (singular) | a snap, a SNAP |
20+
| web3 | Web3, WEB3 (capitalize only at sentence start) |
21+
| sign in / sign out (verb) | log in, log out, login, logout (as verbs) |
22+
| sign-in / sign-out (noun or adjective) | log-in, log-out, login, logout (as nouns/adj) |
23+
| onchain / offchain | on-chain, off-chain |
24+
| Wallet Standard, Wallet Adapter | wallet-standard, wallet-adapter (except in URLs) |
2425

2526
## Standards and specifications
2627

0 commit comments

Comments
 (0)