From 9b1f647ebe6a96d7941af7e94c8708f68a4be448 Mon Sep 17 00:00:00 2001 From: Alexandra Carrillo Date: Tue, 18 Nov 2025 18:59:17 -0800 Subject: [PATCH 1/3] Update all CardList links to absolute and add guidance --- CONTRIBUTING.md | 39 ++++++++++++++++--- developer-tools/dashboard/index.md | 6 +-- gator_versioned_docs/version-0.1.0/index.mdx | 10 ++--- gator_versioned_docs/version-0.13.0/index.md | 8 ++-- services/reference/arbitrum/index.md | 4 +- services/reference/avalanche-c-chain/index.md | 4 +- services/reference/base/index.md | 4 +- services/reference/blast/index.md | 4 +- services/reference/bnb-smart-chain/index.md | 4 +- services/reference/celo/index.md | 4 +- services/reference/ethereum/index.md | 4 +- services/reference/gas-api/index.md | 4 +- services/reference/hemi/index.md | 4 +- services/reference/ipfs/index.md | 4 +- services/reference/linea/index.md | 4 +- services/reference/mantle/index.md | 4 +- services/reference/opbnb/index.md | 4 +- services/reference/optimism/index.md | 4 +- services/reference/palm/index.md | 4 +- services/reference/polygon-pos/index.md | 4 +- services/reference/scroll/index.md | 4 +- services/reference/sei/index.md | 4 +- services/reference/solana/index.md | 4 +- services/reference/starknet/index.md | 4 +- services/reference/swellchain/index.md | 4 +- services/reference/unichain/index.md | 4 +- services/reference/zksync/index.md | 4 +- smart-accounts-kit/index.mdx | 10 ++--- 28 files changed, 96 insertions(+), 69 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3da5ba2b586..b469a856f64 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -71,10 +71,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). @@ -116,10 +116,37 @@ 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 title="Relative file path in Smart Accounts Kit docs" +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 title="Absolute URL path in Wallet API docs" +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 title="Absolute URL path in Snaps docs" + +``` + ## 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. diff --git a/developer-tools/dashboard/index.md b/developer-tools/dashboard/index.md index 6f02484793e..1f49212a3a8 100644 --- a/developer-tools/dashboard/index.md +++ b/developer-tools/dashboard/index.md @@ -24,17 +24,17 @@ Select one of the cards below to learn more about using the dashboard. Date: Tue, 18 Nov 2025 19:05:35 -0800 Subject: [PATCH 2/3] edit contribution guide --- CONTRIBUTING.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b469a856f64..07b339e0cef 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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) @@ -120,17 +121,18 @@ Refer to the [Consensys documentation style guide](https://docs-template.consens Most links in the Markdown pages use *relative file paths*, for example: -```md title="Relative file path in Smart Accounts Kit docs" +```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 title="Absolute URL path in Wallet API docs" -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 +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 title="Absolute URL path in Snaps docs" +```md Date: Tue, 18 Nov 2025 19:32:02 -0800 Subject: [PATCH 3/3] fix linkspector errors --- .linkspector.yml | 2 ++ services/reference/mantle/index.md | 2 +- services/reference/unichain/index.md | 4 +--- wallet/concepts/wallet-interoperability.md | 2 +- wallet/how-to/connect-extension.md | 2 +- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/.linkspector.yml b/.linkspector.yml index 24b55b1bf36..0c12466ee51 100644 --- a/.linkspector.yml +++ b/.linkspector.yml @@ -32,6 +32,8 @@ ignorePatterns: - pattern: '^/snaps/' - pattern: '^/wallet/' - pattern: '^/tutorials/' +- pattern: 'https://web3onboard.thirdweb.com' +- pattern: 'https://0xfury.com/privacy' aliveStatusCodes: - 200 - 206 diff --git a/services/reference/mantle/index.md b/services/reference/mantle/index.md index 7d929c50884..44ad1b42966 100644 --- a/services/reference/mantle/index.md +++ b/services/reference/mantle/index.md @@ -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)) diff --git a/services/reference/unichain/index.md b/services/reference/unichain/index.md index ccc6edbd4dc..4aef7c9a8af 100644 --- a/services/reference/unichain/index.md +++ b/services/reference/unichain/index.md @@ -58,7 +58,5 @@ No personal information is sent as part of partner requests, only information ne The following partners provide access to the Unichain network: - - InfStones ([Privacy Policy](https://infstones.com/terms/privacy-notice)) -- 0xFury ([Privacy policy](https://0xfury.com/privacy.php)) - +- 0xFury ([Privacy policy](https://0xfury.com/privacy)) diff --git a/wallet/concepts/wallet-interoperability.md b/wallet/concepts/wallet-interoperability.md index 9497bc6f03b..4bdbdefa1f4 100644 --- a/wallet/concepts/wallet-interoperability.md +++ b/wallet/concepts/wallet-interoperability.md @@ -84,7 +84,7 @@ The following third-party libraries support EIP-6963: - [MIPD Store](https://github.com/wevm/mipd) - [RainbowKit](https://www.rainbowkit.com) - [Web3-Onboard](https://web3onboard.thirdweb.com) -- [ConnectKit](https://docs.family.co/connectkit) +- [ConnectKit](https://family.co/docs/connectkit) ### MIPD Store diff --git a/wallet/how-to/connect-extension.md b/wallet/how-to/connect-extension.md index 9e4b29f08c9..e1a36f36ea8 100644 --- a/wallet/how-to/connect-extension.md +++ b/wallet/how-to/connect-extension.md @@ -34,7 +34,7 @@ You can connect to MetaMask using the following third-party libraries that suppo - [MIPD Store](https://github.com/wevm/mipd) - [RainbowKit](https://rainbowkit.com/docs/introduction) - [Web3-Onboard](https://web3onboard.thirdweb.com) -- [ConnectKit](https://docs.family.co/connectkit) +- [ConnectKit](https://family.co/docs/connectkit) ## Connect to MetaMask directly using Vite