Migrate MM SDK to MM Connect EVM on MetaMask docs

.gitignore

@@ -23,6 +23,7 @@ npm-debug.log*
 .envrc
 .env
 .integrationBuilderCache
+.cursor
 
 # Generated Snaps docs
 snaps/reference/snaps-api/*.mdx

.linkspector.yml

@@ -2,10 +2,9 @@ dirs:
   - ./smart-accounts-kit
   - ./developer-tools
   - ./embedded-wallets
-  - ./sdk
+  - ./metamask-connect
   - ./services
   - ./snaps
-  - ./wallet
 excludedDirs:
   - ./build
   - ./.vercel
@@ -28,13 +27,15 @@ ignorePatterns:
 - pattern: '^/smart-accounts-kit/'
 - pattern: '^/developer-tools/'
 - pattern: '^/embedded-wallets/'
-- pattern: '^/sdk/'
+- pattern: '^/metamask-connect/'
 - pattern: '^/services/'
 - pattern: '^/snaps/'
 - pattern: '^/wallet/'
 - pattern: '^/tutorials/'
 - pattern: 'https://web3onboard.thirdweb.com'
 - pattern: 'https://0xfury.com/privacy'
+- pattern: '^https://docs.arbitrum.io'
+- pattern: '^https://nodefleet.org'
 aliveStatusCodes:
 - 200
 - 206

CONTRIBUTING.md

@@ -12,9 +12,6 @@ guide in some places.
 - [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)
-  - [Update `ethereum/execution-apis`](#update-ethereumexecution-apis)
 - [Test analytics](#test-analytics)
 
 ## Contribution workflow
@@ -74,7 +71,7 @@ To contribute changes:
    >
    > - 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`,
+   > - If you add a new documentation page, edit `mm-connect-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
@@ -119,13 +116,13 @@ Refer to the [Consensys documentation style guide](https://docs-template.consens
 
 ## Format links
 
-Most links in the Markdown pages use *relative file paths*, for example:
+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:
+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
@@ -134,14 +131,14 @@ externally owned account (EOA) to a [MetaMask smart account](/smart-accounts-kit
 
 ```md
 <CardList
-  items={[
-    {
-      href: '/snaps/learn/about-snaps',
-      title: 'About Snaps',
-      description: 'See a high-level, technical overview of the Snaps system.',
-    },
-    ...
-  ]}
+items={[
+{
+href: '/snaps/learn/about-snaps',
+title: 'About Snaps',
+description: 'See a high-level, technical overview of the Snaps system.',
+},
+...
+]}
 />
 ```
 
@@ -154,114 +151,6 @@ When adding a new image, such as a screenshot or diagram, make sure the image ha
 
 Additionally, follow the [Consensys guidelines on adding images](https://docs-template.consensys.net/contribute/add-images).
 
-## Update the interactive API reference
-
-The [Wallet JSON-RPC API reference](https://docs.metamask.io/wallet/reference/json-rpc-api/) uses 
-an internal plugin to import and parse OpenRPC
-specifications from [`MetaMask/api-specs`](https://github.com/MetaMask/api-specs) (MetaMask-specific
-methods) and [`ethereum/execution-apis`](https://github.com/ethereum/execution-apis) (standard
-Ethereum methods).
-The site renders documentation for each method based on the specification, and displays an
-interactive module to test the methods in your browser.
-
-### Update `MetaMask/api-specs`
-
-To update documentation for MetaMask-specific JSON-RPC API methods:
-
-1. Fork [`MetaMask/api-specs`](https://github.com/MetaMask/api-specs), clone the forked repository
-   to your computer, and navigate into it:
-
-   ```bash
-   git clone git@github.com:<YOUR-USERNAME>/api-specs.git
-   cd api-specs
-   ```
-
-2. Follow the repository's [`README.md`](https://github.com/MetaMask/api-specs/blob/main/README.md)
-   instructions to edit the OpenRPC specification and generate the output file, `openrpc.json`.
-
-3. To test the API updates in the MetaMask doc site's interactive reference:
-
-   1. Create and switch to a temporary local branch of the doc site, [`MetaMask/metamask-docs`](https://github.com/MetaMask/metamask-docs).
-      For example, to create and switch to a branch named `test-api-updates`:
-      ```bash
-      cd metamask-docs
-      git checkout -b test-api-updates
-      ```
-   2. Copy and paste the output file `openrpc.json` into the root directory of `metamask-docs`.
-   3. Use [`http-server`](https://www.npmjs.com/package/http-server) to serve `openrpc.json` locally.
-      Install `http-server` if you haven't yet, and start the server:
-      ```bash
-      npm install --global http-server
-      http-server
-      ```
-      The `openrpc.json` file is now served at [`http://127.0.0.1:8080/openrpc.json`](http://127.0.0.1:8080/openrpc.json).
-   4. In `src/plugins/plugin-json-rpc.ts`, update the following line to point to the locally served `openrpc.json` file:
-      ```diff
-      -  export const MM_RPC_URL = "https://metamask.github.io/api-specs/latest/openrpc.json";
-      +  export const MM_RPC_URL = "http://127.0.0.1:8080/openrpc.json";
-      ```
-   5. In a new terminal window, preview the doc site locally:
-      ```bash
-      cd metamask-docs
-      npm start
-      ```
-   6. Navigate to the API reference, and view your updates.
-
-4. Add and commit your changes to `api-specs`, and create a PR.
-
-5. Once your PR is approved and merged, the following must happen to publish the changes to the
-   MetaMask doc site:
-
-   1. A new version of `api-specs` must be released by a user with write access to the repository.
-      To release, go to the [Create Release Pull Request](https://github.com/MetaMask/api-specs/actions/workflows/create-release-pr.yml)
-      action, select **Run workflow**, and enter a specific version to bump to in the last text box
-      (for example, `0.10.6`). This creates a PR releasing a version of `api-specs`.
-   2. Once the release PR is merged, the [Publish Release](https://github.com/MetaMask/api-specs/actions/workflows/publish-release.yml)
-      action must be approved by an npm publisher.
-      You can request an approval in the **#metamask-dev** Slack channel tagging
-      **@metamask-npm-publishers**.
-      For example:
-      > @metamask-npm-publishers `@metamask/api-specs@0.10.6` is awaiting deployment :rocketship:
-      https://github.com/MetaMask/api-specs/actions/runs/10615788573
-
-### Update `ethereum/execution-apis`
-
-To update documentation for standard Ethereum JSON-RPC API methods:
-
-1. Fork [`ethereum/execution-apis`](https://github.com/ethereum/execution-apis), clone the forked
-   repository to your computer, and navigate into it:
-
-   ```bash
-   git clone git@github.com:<YOUR-USERNAME>/execution-apis.git
-   cd execution-apis
-   ```
-
-2. Follow the repository's [`README.md`](https://github.com/ethereum/execution-apis/blob/main/README.md)
-   instructions to edit the OpenRPC specification and generate the output file, `openrpc.json`.
-
-3. To test the API updates in the MetaMask doc site's interactive reference, complete Step 3 in
-   [Update `MetaMask/api-specs`](#update-metamaskapi-specs).
-
-4. Add and commit your changes to `execution-apis`, and create a PR.
-
-5. Once your PR is approved and merged, the following must happen to publish the changes to the
-   MetaMask doc site:
-
-   1. `api-specs` must import the updated Ethereum API specification.
-      Go to the [commit history](https://github.com/ethereum/execution-apis/commits/assembled-spec/)
-      of the `assembled-spec` branch of `execution-apis`.
-      Copy the full commit hash of the latest commit titled "assemble openrpc.json."
-      Update the following line in `merge-openrpc.js` of `api-specs` with the updated commit hash,
-      and create a PR:
-      ```diff
-      const getFilteredExecutionAPIs = () => {
-      -  return fetch("https://raw.githubusercontent.com/ethereum/execution-apis/ac19b518a2596221cd7cd6421ee3dc654d7ff3b7/refs-openrpc.json")
-      +  return fetch("https://raw.githubusercontent.com/ethereum/execution-apis/f75d4cc8eeb5d1952bd69f901954686b74c34c9b/refs-openrpc.json")
-      ```
-   2. Once the change to `merge-openrpc.js` is merged, Step 5 in
-      [Update `MetaMask/api-specs`](#update-metamaskapi-specs) must be completed to publish the
-      changes to the MetaMask doc site.
-
 ## Test analytics
 
 The [`docusaurus-plugin-segment`](https://github.com/xer0x/docusaurus-plugin-segment) plugin enables

docusaurus.config.js

@@ -5,12 +5,6 @@ import fs from 'fs'
 require('dotenv').config()
 const { themes } = require('prism-react-renderer')
 const { REF_ALLOW_LOGIN_PATH } = require('./src/lib/constants')
-const {
-  fetchAndGenerateDynamicSidebarItems,
-  NETWORK_NAMES,
-  MM_REF_PATH,
-  MM_RPC_URL,
-} = require('./src/plugins/plugin-json-rpc')
 const codeTheme = themes.dracula
 const productsDropdown = fs.readFileSync('./src/components/NavDropdown/Products.html', 'utf-8')
 const baseUrl = process.env.DEST || '/'
@@ -81,14 +75,36 @@ const config = {
       attributes: {
         type: 'application/ld+json',
       },
-      innerHTML: `
+      innerHTML: JSON.stringify({
+        "@context": "https://schema.org",
+        "@type": "Organization",
+        "@id": `${fullUrl}#organization`,
+        "name": "MetaMask",
+        "url": fullUrl,
+        "logo": new URL('img/favicons/favicon-96x96.png', fullUrl).toString(),
+        "description": "MetaMask is the leading self-custodial cryptocurrency wallet and Web3 gateway, enabling developers to build dapps that connect to MetaMask across EVM and Solana ecosystems.",
+        "sameAs": [
+          "https://github.com/MetaMask",
+          "https://twitter.com/MetaMask",
+          "https://www.linkedin.com/company/metamask",
+          "https://metamask.io"
+        ]
+      }),
+    },
     {
-      "@context": "https://schema.org",
-      "@type": "Organization",
-      "url": "${fullUrl}",
-      "logo": "${new URL('img/favicons/favicon-96x96.png', fullUrl).toString()}"
-    }
-  `,
+      tagName: 'script',
+      attributes: {
+        type: 'application/ld+json',
+      },
+      innerHTML: JSON.stringify({
+        "@context": "https://schema.org",
+        "@type": "WebSite",
+        "@id": `${fullUrl}#website`,
+        "name": "MetaMask Developer Documentation",
+        "url": fullUrl,
+        "publisher": { "@id": `${fullUrl}#organization` },
+        "description": "Official developer documentation for MetaMask Connect, Embedded Wallets, Snaps, and the MetaMask developer platform."
+      }),
     },
   ],
 
@@ -115,6 +131,7 @@ const config = {
     DISCOURSE_API_KEY: process.env.DISCOURSE_API_KEY,
     DISCOURSE_API_USERNAME: process.env.DISCOURSE_API_USERNAME,
     DISCOURSE_CATEGORY_ID: process.env.DISCOURSE_CATEGORY_ID,
+    INFURA_API_KEY: process.env.INFURA_API_KEY || '',
   },
 
   trailingSlash: true,
@@ -265,37 +282,13 @@ const config = {
     [
       '@docusaurus/plugin-content-docs',
       {
-        id: 'wallet',
-        path: 'wallet',
-        routeBasePath: 'wallet',
+        id: 'metamask-connect',
+        path: 'metamask-connect',
+        routeBasePath: 'metamask-connect',
         editUrl: 'https://github.com/MetaMask/metamask-docs/edit/main/',
-        sidebarPath: require.resolve('./wallet-sidebar.js'),
-        breadcrumbs: false,
-        remarkPlugins,
-        rehypePlugins,
-        sidebarItemsGenerator: async function ({ defaultSidebarItemsGenerator, ...args }) {
-          const sidebarItems = await defaultSidebarItemsGenerator(args)
-          const dynamicItems = await fetchAndGenerateDynamicSidebarItems(
-            MM_RPC_URL,
-            MM_REF_PATH,
-            NETWORK_NAMES.metamask
-          )
-          if (args.item.dirName === 'reference/json-rpc-methods') {
-            return [...sidebarItems, ...dynamicItems]
-          }
-          return sidebarItems
-        },
-      },
-    ],
-    [
-      '@docusaurus/plugin-content-docs',
-      {
-        id: 'sdk',
-        path: 'sdk',
-        routeBasePath: 'sdk',
-        editUrl: 'https://github.com/MetaMask/metamask-docs/edit/main/',
-        sidebarPath: require.resolve('./sdk-sidebar.js'),
+        sidebarPath: require.resolve('./mm-connect-sidebar.js'),
         breadcrumbs: false,
+        showLastUpdateTime: true,
         remarkPlugins,
         rehypePlugins,
       },
@@ -384,18 +377,18 @@ const config = {
             description: 'Complete documentation for MetaMask Embedded Wallets',
           },
           {
-            filename: 'llms-sdk.txt',
-            includePatterns: ['sdk/**/*.{md,mdx}'],
+            filename: 'llms-metamask-connect.txt',
+            includePatterns: ['metamask-connect/**/*.{md,mdx}'],
             fullContent: false,
-            title: 'MetaMask SDK documentation',
-            description: 'Documentation links for MetaMask SDK',
+            title: 'MetaMask Connect documentation',
+            description: 'Documentation links for MetaMask Connect',
           },
           {
-            filename: 'llms-sdk-full.txt',
-            includePatterns: ['sdk/**/*.{md,mdx}'],
+            filename: 'llms-metamask-connect-full.txt',
+            includePatterns: ['metamask-connect/**/*.{md,mdx}'],
             fullContent: true,
-            title: 'MetaMask SDK documentation',
-            description: 'Complete documentation for MetaMask SDK',
+            title: 'MetaMask Connect documentation',
+            description: 'Complete documentation for MetaMask Connect',
           },
           {
             filename: 'llms-smart-accounts-kit.txt',
@@ -493,7 +486,7 @@ const config = {
         {
           name: 'keywords',
           content:
-            'MetaMask, Embedded Wallets, Quickstart, Web3 Development, SDK, Wallet Integration, API, Dapp Development, Blockchain Development, Ethereum Development, Smart Contract, Account Abstraction, Snaps, Crypto Wallet, DeFi, NFT, Infura, Services, Dashboard',
+            'MetaMask, Embedded Wallets, Quickstart, Web3 Development, SDK, MetaMask Connect, Wallet Integration, API, Dapp Development, Blockchain Development, Ethereum Development, Smart Contract, Account Abstraction, Snaps, Crypto Wallet, DeFi, NFT, Infura, Services, Dashboard',
         },
         // Twitter-specific meta tags
         {
@@ -612,21 +605,17 @@ const config = {
             title: 'Documentation',
             items: [
               {
-                label: 'SDK',
-                to: '/sdk',
+                label: 'MetaMask Connect',
+                to: '/metamask-connect',
               },
               {
-                label: 'Wallet API',
-                to: '/wallet',
+                label: 'Embedded Wallets',
+                to: '/embedded-wallets',
               },
               {
                 label: 'Smart Accounts Kit',
                 to: '/smart-accounts-kit',
               },
-              {
-                label: 'Embedded Wallets',
-                to: '/embedded-wallets',
-              },
               {
                 label: 'Snaps',
                 to: '/snaps',
@@ -653,7 +642,7 @@ const config = {
                 href: 'https://github.com/MetaMask/metamask-extension/',
               },
               {
-                label: 'MetaMask SDK GitHub',
+                label: 'MetaMask Connect GitHub',
                 href: 'https://github.com/MetaMask/metamask-sdk/',
               },
               {
@@ -798,7 +787,7 @@ const config = {
       },
       mermaid: {
         options: {
-          fontFamily: 'arial, verdana, sans-serif;',
+          fontFamily: 'arial, verdana, sans-serif',
           wrap: true,
           securityLevel: 'loose',
           sequence: {