Skip to content

Commit 55e6673

Browse files
authored
Merge branch 'main' into feat/tutorial-builder-hub
2 parents 67c736a + 4fae85d commit 55e6673

File tree

222 files changed

+10255
-5760
lines changed

Some content is hidden

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

222 files changed

+10255
-5760
lines changed

.github/workflows/ci.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ jobs:
1919
name: Build
2020
runs-on: ubuntu-latest
2121
steps:
22-
- uses: actions/checkout@v5
22+
- uses: actions/checkout@v6
2323
- name: Build
2424
uses: ConsenSys/github-actions/docs-build@main
2525

@@ -30,7 +30,7 @@ jobs:
3030
matrix:
3131
folder: ['docs']
3232
steps:
33-
- uses: actions/checkout@v5
33+
- uses: actions/checkout@v6
3434
- name: Case check action
3535
uses: ConsenSys/github-actions/docs-case-check@main
3636
with:
@@ -41,7 +41,7 @@ jobs:
4141
name: Lint Code Base
4242
runs-on: ubuntu-latest
4343
steps:
44-
- uses: actions/checkout@v5
44+
- uses: actions/checkout@v6
4545
- name: Lint
4646
uses: ConsenSys/github-actions/docs-lint-all@main
4747

@@ -52,7 +52,7 @@ jobs:
5252
matrix:
5353
file-extensions: ['.md', '.mdx']
5454
steps:
55-
- uses: actions/checkout@v5
55+
- uses: actions/checkout@v6
5656
- name: Vale
5757
uses: Consensys/github-actions/docs-spelling-check@main
5858
with:
@@ -62,7 +62,7 @@ jobs:
6262
name: Link Checking
6363
runs-on: ubuntu-latest
6464
steps:
65-
- uses: actions/checkout@v5
65+
- uses: actions/checkout@v6
6666
- name: LinkCheck
6767
uses: ConsenSys/github-actions/docs-link-check@main
6868
with:

.github/workflows/crowdin.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ jobs:
1212
runs-on: ubuntu-latest
1313
steps:
1414
- name: Checkout
15-
uses: actions/checkout@v5
15+
uses: actions/checkout@v6
1616

1717
- name: Synchronize with Crowdin
1818
uses: crowdin/github-action@v2

.github/workflows/dependency_review.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ jobs:
1616
permissions:
1717
contents: read
1818
steps:
19-
- uses: actions/checkout@v5
19+
- uses: actions/checkout@v6
2020

2121
- name: Dependency review
2222
uses: ConsenSys/github-actions/js-dependency-review@main

.github/workflows/nightly.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
permissions:
1818
contents: read
1919
steps:
20-
- uses: actions/checkout@v5
20+
- uses: actions/checkout@v6
2121
- name: LinkCheck mdx files
2222
uses: ConsenSys/github-actions/docs-link-check@main
2323
with:
@@ -32,7 +32,7 @@
3232
permissions:
3333
contents: read
3434
steps:
35-
- uses: actions/checkout@v5
35+
- uses: actions/checkout@v6
3636
- name: LinkCheck md files
3737
uses: ConsenSys/github-actions/docs-link-check@main
3838
with:

.github/workflows/security-code-scanner.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ jobs:
1717
contents: read
1818
security-events: write
1919
steps:
20-
- uses: actions/checkout@v5
20+
- uses: actions/checkout@v6
2121
- name: MetaMask Security Code Scanner
2222
uses: ConsenSys/github-actions/mm-security-scanner@main
2323
with:

.github/workflows/trivy-cache.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,6 @@ jobs:
1414
name: Run trivy scanner
1515
runs-on: ubuntu-latest
1616
steps:
17-
- uses: actions/checkout@v5
17+
- uses: actions/checkout@v6
1818
- name: Trivy Cache
1919
uses: ConsenSys/github-actions/trivy-update-cache@main

.github/workflows/trivy.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ jobs:
1010
name: Run trivy scanner
1111
runs-on: ubuntu-latest
1212
steps:
13-
- uses: actions/checkout@v5
13+
- uses: actions/checkout@v6
1414
- name: Trivy
1515
uses: ConsenSys/github-actions/trivy@main
1616
with:

.linkspector.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@ ignorePatterns:
3232
- pattern: '^/snaps/'
3333
- pattern: '^/wallet/'
3434
- pattern: '^/tutorials/'
35+
- pattern: 'https://web3onboard.thirdweb.com'
36+
- pattern: 'https://0xfury.com/privacy'
3537
aliveStatusCodes:
3638
- 200
3739
- 206

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

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)