Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .linkspector.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ ignorePatterns:
- pattern: '^/snaps/'
- pattern: '^/wallet/'
- pattern: '^/tutorials/'
- pattern: 'https://web3onboard.thirdweb.com'
- pattern: 'https://0xfury.com/privacy'
aliveStatusCodes:
- 200
- 206
Expand Down
41 changes: 35 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ guide in some places.
- [Contribution workflow](#contribution-workflow)
- [Preview locally](#preview-locally)
- [Style guide](#style-guide)
- [Format links](#format-links)
- [Add images](#add-images)
- [Update the interactive API reference](#update-the-interactive-api-reference)
- [Update `MetaMask/api-specs`](#update-metamaskapi-specs)
Expand Down Expand Up @@ -71,10 +72,10 @@ To contribute changes:

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

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

## Format links

Most links in the Markdown pages use *relative file paths*, for example:

```md
You can enable users to create a [MetaMask smart account](../../concepts/smart-accounts.md) directly in your dapp.
```

However, when linking between different product sections or using the `CardList` component, use *absolute URL paths*. For example:

```md
When a dapp requests to submit a batch of transactions atomically, MetaMask may prompt users to upgrade their
externally owned account (EOA) to a [MetaMask smart account](/smart-accounts-kit/concepts/smart-accounts).
```

```md
<CardList
items={[
{
href: '/snaps/learn/about-snaps',
title: 'About Snaps',
description: 'See a high-level, technical overview of the Snaps system.',
},
...
]}
/>
```

## Add images

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

Expand Down
6 changes: 3 additions & 3 deletions developer-tools/dashboard/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,17 +24,17 @@ Select one of the cards below to learn more about using the dashboard.
<CardList
items={[
{
href: "./get-started/create-api",
href: "/developer-tools/dashboard/get-started/create-api",
title: "Create an API key",
description: "Learn how to create an API key that allows you to make API calls."
},
{
href: "./how-to/secure-an-api/api-key",
href: "/developer-tools/dashboard/how-to/secure-an-api/api-key",
title: "Secure your API key",
description: "Learn how to secure your API key to avoid unwanted costs and unauthorized access."
},
{
href: "./how-to/dashboard-stats",
href: "/developer-tools/dashboard/how-to/dashboard-stats",
title: "Monitor API call stats",
description: "Learn how to use the dashboard to view API call stats."
}
Expand Down
10 changes: 5 additions & 5 deletions gator_versioned_docs/version-0.1.0/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,12 @@ Delegation is powered by the [Delegation Framework](https://github.com/metamask/

<CardList items={[
{
href: "get-started/smart-account-quickstart",
href: "/smart-accounts-kit/get-started/smart-account-quickstart",
title: "Smart account quickstart",
description: "Create a MetaMask smart account and send a user operation.",
},
{
href: "guides/delegation/execute-on-smart-accounts-behalf",
href: "/smart-accounts-kit/guides/delegation/execute-on-smart-accounts-behalf",
title: "Delegation guide",
description: "Execute on the behalf of MetaMask Smart Accounts.",
}
Expand All @@ -40,7 +40,7 @@ Advanced Permissions allow you to perform executions on the behalf of MetaMask u

<CardList items={[
{
href: "guides/advanced-permissions/execute-on-metamask-users-behalf",
href: "/smart-accounts-kit/guides/advanced-permissions/execute-on-metamask-users-behalf",
title: "Advanced Permissions (ERC-7715) guide",
description: "Execute on the behalf of MetaMask users.",
}
Expand All @@ -54,12 +54,12 @@ Check out the following documentation from these partners:
<CardList
items={[
{
href: "get-started/use-scaffold-eth/smart-accounts",
href: "/smart-accounts-kit/get-started/use-scaffold-eth/smart-accounts",
title: "Smart Accounts with Scaffold-ETH 2",
description: "Install the MetaMask Smart Accounts extension for Scaffold-ETH 2.",
},
{
href: "get-started/use-scaffold-eth/advanced-permissions",
href: "/smart-accounts-kit/get-started/use-scaffold-eth/advanced-permissions",
title: "Advanced Permissions with Scaffold-ETH 2",
description: "Install the MetaMask Advanced Permissions (ERC-7715) extension for Scaffold-ETH 2.",
},
Expand Down
8 changes: 4 additions & 4 deletions gator_versioned_docs/version-0.13.0/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,22 +43,22 @@ Check out the following guides to get started with the MetaMask Delegation Toolk
<CardList
items={[
{
href: "get-started/install",
href: "/smart-accounts-kit/0.13.0/get-started/install",
title: "Install and set up",
description: "Install and set up the MetaMask Delegation Toolkit.",
},
{
href: "get-started/smart-account-quickstart",
href: "/smart-accounts-kit/0.13.0/get-started/smart-account-quickstart",
title: "MetaMask Smart Accounts quickstart",
description: "Create a MetaMask smart account and send a user operation.",
},
{
href: "get-started/smart-account-quickstart/eip7702",
href: "/smart-accounts-kit/0.13.0/get-started/smart-account-quickstart/eip7702",
title: "EIP-7702 quickstart",
description: "Upgrade an externally owned account to a smart account.",
},
{
href: "get-started/use-the-cli",
href: "/smart-accounts-kit/0.13.0/get-started/use-the-cli",
title: "Use the CLI",
description: "Use the Delegation Toolkit CLI to bootstrap a project.",
}
Expand Down
4 changes: 2 additions & 2 deletions services/reference/arbitrum/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,12 @@ Select one of the following options to get started with the Arbitrum network:
<CardList
items={[
{
href: "./quickstart",
href: "/services/reference/arbitrum/quickstart",
title: "Quickstart",
description: "Learn how to quickly connect to Arbitrum and make calls to the network."
},
{
href: "./json-rpc-methods",
href: "/services/reference/arbitrum/json-rpc-methods",
title: "JSON-RPC APIs",
description: "View the APIs available for communicating with the Arbitrum network."
},
Expand Down
4 changes: 2 additions & 2 deletions services/reference/avalanche-c-chain/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,12 @@
<CardList
items={[
{
href: "./quickstart",
href: "/services/reference/avalanche-c-chain/quickstart",

Check failure on line 42 in services/reference/avalanche-c-chain/index.md

View workflow job for this annotation

GitHub Actions / Spelling (.mdx)

[vale] reported by reviewdog 🐶 [Vale.Terms] Use 'C-Chain' instead of 'c-chain'. Raw Output: {"message": "[Vale.Terms] Use 'C-Chain' instead of 'c-chain'.", "location": {"path": "services/reference/avalanche-c-chain/index.md", "range": {"start": {"line": 42, "column": 44}}}, "severity": "ERROR"}
title: "Quickstart",
description: "Learn how to quickly connect to Avalanche C-Chain and make calls to the network."
},
{
href: "./json-rpc-methods",
href: "/services/reference/avalanche-c-chain/json-rpc-methods",

Check failure on line 47 in services/reference/avalanche-c-chain/index.md

View workflow job for this annotation

GitHub Actions / Spelling (.mdx)

[vale] reported by reviewdog 🐶 [Vale.Terms] Use 'C-Chain' instead of 'c-chain'. Raw Output: {"message": "[Vale.Terms] Use 'C-Chain' instead of 'c-chain'.", "location": {"path": "services/reference/avalanche-c-chain/index.md", "range": {"start": {"line": 47, "column": 44}}}, "severity": "ERROR"}
title: "JSON-RPC APIs",
description: "View the APIs available for communicating with the Avalanche C-Chain network."
},
Expand Down
4 changes: 2 additions & 2 deletions services/reference/base/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,12 @@ Select an option below to get started with the Base network.
<CardList
items={[
{
href: "./quickstart",
href: "/services/reference/base/quickstart",
title: "Quickstart",
description: "Learn how to quickly connect and make calls to the Base network."
},
{
href: "./json-rpc-methods",
href: "/services/reference/base/json-rpc-methods",
title: "JSON-RPC APIs",
description: "View the APIs available for communicating with the Base network."
},
Expand Down
4 changes: 2 additions & 2 deletions services/reference/blast/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,12 @@ Select one of the following options to get started with the Blast network:
<CardList
items={[
{
href: "./quickstart",
href: "/services/reference/blast/quickstart",
title: "Quickstart",
description: "Learn how to quickly connect and make calls to the Blast network."
},
{
href: "./json-rpc-methods",
href: "/services/reference/blast/json-rpc-methods",
title: "JSON-RPC APIs",
description: "View the APIs available for communicating with the Blast network."
},
Expand Down
4 changes: 2 additions & 2 deletions services/reference/bnb-smart-chain/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,12 @@ Select an option below to get started with the BSC network.
<CardList
items={[
{
href: "./quickstart",
href: "/services/reference/bnb-smart-chain/quickstart",
title: "Quickstart",
description: "Learn how to quickly connect and make calls to the BNB Smart Chain network."
},
{
href: "./json-rpc-methods",
href: "/services/reference/bnb-smart-chain/json-rpc-methods",
title: "JSON-RPC APIs",
description: "View the APIs available for communicating with the BNB Smart Chain network."
},
Expand Down
4 changes: 2 additions & 2 deletions services/reference/celo/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,12 @@ Select an option below to get started with the Celo network.
<CardList
items={[
{
href: "./quickstart",
href: "/services/reference/celo/quickstart",
title: "Quickstart",
description: "Learn how to quickly connect and make calls to the Celo network."
},
{
href: "./json-rpc-methods",
href: "/services/reference/celo/json-rpc-methods",
title: "JSON-RPC APIs",
description: "View the APIs available for communicating with the Celo network."
},
Expand Down
4 changes: 2 additions & 2 deletions services/reference/ethereum/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@
<CardList
items={[
{
href: "./quickstart",
href: "/services/reference/ethereum/quickstart",

Check failure on line 27 in services/reference/ethereum/index.md

View workflow job for this annotation

GitHub Actions / Spelling (.mdx)

[vale] reported by reviewdog 🐶 [Vale.Terms] Use 'Ethereum' instead of 'ethereum'. Raw Output: {"message": "[Vale.Terms] Use 'Ethereum' instead of 'ethereum'.", "location": {"path": "services/reference/ethereum/index.md", "range": {"start": {"line": 27, "column": 34}}}, "severity": "ERROR"}
title: "Quickstart",
description: "Learn how to quickly connect and make calls to the Ethereum network."
},
{
href: "./json-rpc-methods",
href: "/services/reference/ethereum/json-rpc-methods",

Check failure on line 32 in services/reference/ethereum/index.md

View workflow job for this annotation

GitHub Actions / Spelling (.mdx)

[vale] reported by reviewdog 🐶 [Vale.Terms] Use 'Ethereum' instead of 'ethereum'. Raw Output: {"message": "[Vale.Terms] Use 'Ethereum' instead of 'ethereum'.", "location": {"path": "services/reference/ethereum/index.md", "range": {"start": {"line": 32, "column": 34}}}, "severity": "ERROR"}
title: "JSON-RPC APIs",
description: "View the APIs available for communicating with the Ethereum network."
},
Expand Down
4 changes: 2 additions & 2 deletions services/reference/gas-api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@ See the [list of supported Gas API networks](../../get-started/endpoints.md#gas-
<CardList
items={[
{
href: "./quickstart",
href: "/services/reference/gas-api/quickstart",
title: "Quickstart",
description: "Learn how to quickly connect and make calls to the Gas API."
},
{
href: "./api-reference",
href: "/services/reference/gas-api/api-reference",
title: "REST APIs",
description: "View the APIs available for communicating with the Gas API."
},
Expand Down
4 changes: 2 additions & 2 deletions services/reference/hemi/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,12 @@ Select an option below to get started with the Hemi network.
<CardList
items={[
{
href: "./quickstart",
href: "/services/reference/hemi/quickstart",
title: "Quickstart",
description: "Learn how to quickly connect and make calls to the Hemi network."
},
{
href: "./json-rpc-methods",
href: "/services/reference/hemi/json-rpc-methods",
title: "JSON-RPC APIs",
description: "View the APIs available for communicating with the Hemi network."
},
Expand Down
4 changes: 2 additions & 2 deletions services/reference/ipfs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,12 @@ See the [official IPFS documentation](https://docs.ipfs.io) for more information
<CardList
items={[
{
href: "./quickstart",
href: "/services/reference/ipfs/quickstart",
title: "Quickstart",
description: "Learn how to quickly connect and make calls to the IPFS network."
},
{
href: "./http-api-methods",
href: "/services/reference/ipfs/http-api-methods",
title: "HTTP APIs",
description: "View the APIs available for communicating with the IPFS network."
},
Expand Down
4 changes: 2 additions & 2 deletions services/reference/linea/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@ See the [official Linea documentation](https://docs.linea.build/) for more infor
<CardList
items={[
{
href: "./quickstart",
href: "/services/reference/linea/quickstart",
title: "Quickstart",
description: "Learn how to quickly connect and make calls to the Linea network."
},
{
href: "./json-rpc-methods",
href: "/services/reference/linea/json-rpc-methods",
title: "JSON-RPC APIs",
description: "View the APIs available for communicating with the Linea network."
},
Expand Down
6 changes: 3 additions & 3 deletions services/reference/mantle/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,12 @@ Select one of the following options to get started with the Mantle network:
<CardList
items={[
{
href: "./quickstart",
href: "/services/reference/mantle/quickstart",
title: "Quickstart",
description: "Learn how to quickly connect and make calls to the Mantle network."
},
{
href: "./json-rpc-methods",
href: "/services/reference/mantle/json-rpc-methods",
title: "JSON-RPC APIs",
description: "View the APIs available for communicating with the Mantle network."
},
Expand All @@ -57,5 +57,5 @@ No personal information is sent as part of partner requests, only information ne

The following partner provides access to the Mantle network:

- 0xFury ([Privacy policy](https://0xfury.com/privacy.php))
- 0xFury ([Privacy policy](https://0xfury.com/privacy))
- Bware Labs ([Terms of Use](https://bwarelabs.com/terms), [Privacy Policy](https://bwarelabs.com/privacy))
4 changes: 2 additions & 2 deletions services/reference/opbnb/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,12 @@ Select an option below to get started with the opBNB network.
<CardList
items={[
{
href: "./quickstart",
href: "/services/reference/opbnb/quickstart",
title: "Quickstart",
description: "Learn how to quickly connect and make calls to the opBNB network."
},
{
href: "./json-rpc-methods",
href: "/services/reference/opbnb/json-rpc-methods",
title: "JSON-RPC APIs",
description: "View the APIs available for communicating with the opBNB network."
},
Expand Down
4 changes: 2 additions & 2 deletions services/reference/optimism/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,12 @@ occur on Optimism are posted and validated on Ethereum mainnet using Optimistic
<CardList
items={[
{
href: "./quickstart",
href: "/services/reference/optimism/quickstart",
title: "Quickstart",
description: "Learn how to quickly connect and make calls to the Optimism network."
},
{
href: "./json-rpc-methods",
href: "/services/reference/optimism/json-rpc-methods",
title: "JSON-RPC APIs",
description: "View the APIs available for communicating with the Optimism network."
},
Expand Down
4 changes: 2 additions & 2 deletions services/reference/palm/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@ The [official Palm documentation](https://docs.palm.io/) for more information ab
<CardList
items={[
{
href: "./quickstart",
href: "/services/reference/palm/quickstart",
title: "Quickstart",
description: "Learn how to quickly connect and make calls to the Palm network."
},
{
href: "./json-rpc-methods",
href: "/services/reference/palm/json-rpc-methods",
title: "JSON-RPC APIs",
description: "View the APIs available for communicating with the Palm network."
},
Expand Down
Loading
Loading