Skip to content

Commit f7d0980

Browse files
authored
Merge branch 'main' into edit-ew-builder-flutter
2 parents 4f1ac64 + e489f0b commit f7d0980

File tree

1,103 files changed

+27210
-26228
lines changed

Some content is hidden

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

1,103 files changed

+27210
-26228
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,10 @@ Fixes #
1818

1919
- [ ] If this PR updates or adds documentation content that changes or adds technical meaning, it has received an approval from an engineer or DevRel from the relevant team.
2020
- [ ] If this PR updates or adds documentation content, it has received an approval from a technical writer.
21+
22+
## External contributor checklist
23+
24+
<!-- If you are an external contributor (outside of the MetaMask organization), complete the following checklist. -->
25+
26+
- [ ] I've read the [contribution guidelines](https://github.com/MetaMask/metamask-docs/blob/main/CONTRIBUTING.md).
27+
- [ ] I've created a new issue (or assigned myself to an existing issue) describing what this PR addresses.

.github/workflows/ci.yml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,12 +61,9 @@ jobs:
6161
linkCheck:
6262
name: Link Checking
6363
runs-on: ubuntu-latest
64-
strategy:
65-
matrix:
66-
file-extensions: ['.md', '.mdx']
6764
steps:
6865
- uses: actions/checkout@v5
6966
- name: LinkCheck
7067
uses: ConsenSys/github-actions/docs-link-check@main
7168
with:
72-
FILE_EXTENSION: ${{ matrix.file-extensions }}
69+
CONFIG_FILE: '.linkspector.yml'

.github/workflows/trivy.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
name: Trivy
3-
43
on:
54
pull_request:
65
branches:

.linkspector.yml

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
dirs:
2+
- ./smart-accounts-kit
3+
- ./developer-tools
4+
- ./embedded-wallets
5+
- ./sdk
6+
- ./services
7+
- ./snaps
8+
- ./wallet
9+
excludedDirs:
10+
- ./build
11+
- ./.vercel
12+
- ./.docusaurus
13+
- ./node_modules
14+
useGitIgnore: true
15+
16+
ignorePatterns:
17+
- pattern: '^http(s)?://localhost'
18+
- pattern: '^http(s)?://127.0.0.1'
19+
- pattern: '^http(s)?://gitlab.com/ConsenSys/'
20+
- pattern: '^http(s)?://consensys.net'
21+
- pattern: '^http(s)?://.+.zendesk.com'
22+
- pattern: '^http(s)?://.+.etherscan.io'
23+
- pattern: '^http(s)?://help.figma.com'
24+
- pattern: '^http(s)?://metamask.io'
25+
- pattern: '^http(s)?://rivet.cloud'
26+
- pattern: '^/img/'
27+
- pattern: '^/smart-accounts-kit/'
28+
- pattern: '^/developer-tools/'
29+
- pattern: '^/embedded-wallets/'
30+
- pattern: '^/sdk/'
31+
- pattern: '^/services/'
32+
- pattern: '^/snaps/'
33+
- pattern: '^/wallet/'
34+
- pattern: '^/tutorials/'
35+
- pattern: 'https://web3onboard.thirdweb.com'
36+
- pattern: 'https://0xfury.com/privacy'
37+
aliveStatusCodes:
38+
- 200
39+
- 206
40+
- 400
41+
- 403

CONTRIBUTING.md

Lines changed: 35 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ guide in some places.
1010
- [Contribution workflow](#contribution-workflow)
1111
- [Preview locally](#preview-locally)
1212
- [Style guide](#style-guide)
13+
- [Format links](#format-links)
1314
- [Add images](#add-images)
1415
- [Update the interactive API reference](#update-the-interactive-api-reference)
1516
- [Update `MetaMask/api-specs`](#update-metamaskapi-specs)
@@ -71,10 +72,10 @@ To contribute changes:
7172

7273
> **Notes:**
7374
>
74-
> - All documentation content is located in the `wallet`, `sdk`, `snaps`, `services`, and
75-
> `developer-tools` directories.
76-
> - If you add a new documentation page, edit `wallet-sidebar.js`, `sdk-sidebar.js`, `snaps-sidebar.js`,
77-
> `services-sidebar.js`, or `dashboard-sidebar.js` to add the page to the
75+
> - All documentation content is located in the `sdk`, `wallet`, `embedded-wallets`, `smart-accounts-kit`, `services`,
76+
> `developer-tools`, `snaps`, and `src/pages` directories.
77+
> - If you add a new documentation page, edit `sdk-sidebar.js`, `wallet-sidebar.js`, `ew-sidebar.js`, `gator-sidebar.js`,
78+
> `services-sidebar.js`, `dashboard-sidebar.js`, or `snaps-sidebar.js` to add the page to the
7879
> [sidebar](https://docs-template.consensys.io/create/configure-docusaurus#sidebar).
7980
> - If you delete, rename, or move a documentation file, add a
8081
> [redirect](https://vercel.com/docs/edge-network/redirects#configuration-redirects).
@@ -116,10 +117,38 @@ To contribute changes:
116117

117118
Refer to the [Consensys documentation style guide](https://docs-template.consensys.net/contribute/style-guide).
118119

120+
## Format links
121+
122+
Most links in the Markdown pages use *relative file paths*, for example:
123+
124+
```md
125+
You can enable users to create a [MetaMask smart account](../../concepts/smart-accounts.md) directly in your dapp.
126+
```
127+
128+
However, when linking between different product sections or using the `CardList` component, use *absolute URL paths*. For example:
129+
130+
```md
131+
When a dapp requests to submit a batch of transactions atomically, MetaMask may prompt users to upgrade their
132+
externally owned account (EOA) to a [MetaMask smart account](/smart-accounts-kit/concepts/smart-accounts).
133+
```
134+
135+
```md
136+
<CardList
137+
items={[
138+
{
139+
href: '/snaps/learn/about-snaps',
140+
title: 'About Snaps',
141+
description: 'See a high-level, technical overview of the Snaps system.',
142+
},
143+
...
144+
]}
145+
/>
146+
```
147+
119148
## Add images
120149

121-
All images are located in the `wallet/assets`, `sdk/_assets`, `snaps/assets`, `services/images`, and
122-
`developer-tools/images` directories.
150+
All images are located in the `sdk/_assets`, `wallet/assets`, `smart-accounts-kit/assets`, `services/images`,
151+
`developer-tools/images`, `snaps/assets`, and `static/img` directories.
123152
When adding a new image, such as a screenshot or diagram, make sure the image has a white or
124153
`#1b1b1d` color background in order for it to be compatible with the site's light and dark modes.
125154

delegation-toolkit/get-started/supported-networks.md

Lines changed: 0 additions & 44 deletions
This file was deleted.

delegation-toolkit/guides/delegation/use-delegation-scopes/function-call.md

Lines changed: 0 additions & 48 deletions
This file was deleted.

delegation-toolkit/index.md

Lines changed: 0 additions & 106 deletions
This file was deleted.

developer-tools/dashboard/how-to/secure-an-api/set-rate-limits.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Set rate limiting in the API key's **Settings** tab **Key Credit Limits** sectio
2828
When the number of used credits reaches this limit, all requests will be rejected until the next day (00:00 UTC).
2929

3030
If you exceed the specified limits, you'll receive a JSON response with an
31-
[HTTP error status code `429`](/services/reference/ethereum/json-rpc-methods#http-errors). For example:
31+
[HTTP error status code `429`](/services/reference/ethereum/json-rpc-methods/#http-errors). For example:
3232

3333
```json
3434
{

developer-tools/dashboard/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,17 +24,17 @@ Select one of the cards below to learn more about using the dashboard.
2424
<CardList
2525
items={[
2626
{
27-
href: "./get-started/create-api",
27+
href: "/developer-tools/dashboard/get-started/create-api",
2828
title: "Create an API key",
2929
description: "Learn how to create an API key that allows you to make API calls."
3030
},
3131
{
32-
href: "./how-to/secure-an-api/api-key",
32+
href: "/developer-tools/dashboard/how-to/secure-an-api/api-key",
3333
title: "Secure your API key",
3434
description: "Learn how to secure your API key to avoid unwanted costs and unauthorized access."
3535
},
3636
{
37-
href: "./how-to/dashboard-stats",
37+
href: "/developer-tools/dashboard/how-to/dashboard-stats",
3838
title: "Monitor API call stats",
3939
description: "Learn how to use the dashboard to view API call stats."
4040
}

0 commit comments

Comments
 (0)