Skip to content

Commit be3c93f

Browse files
Merge branch 'main' into 1956-snaps-mm-links
2 parents 6debaf1 + 35e17eb commit be3c93f

File tree

14 files changed

+493
-115
lines changed

14 files changed

+493
-115
lines changed

.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@v3
19+
- uses: actions/checkout@v4
2020

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

CONTRIBUTING.md

Lines changed: 28 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -129,8 +129,8 @@ Additionally, follow the [Consensys guidelines on adding images](https://docs-te
129129

130130
## Update the interactive API reference
131131

132-
The [Wallet JSON-RPC API reference](https://docs.metamask.io/wallet/reference/json-rpc-api/) uses the
133-
[`docusaurus-openrpc`](https://github.com/MetaMask/docusaurus-openrpc) plugin to import OpenRPC
132+
The [Wallet JSON-RPC API reference](https://docs.metamask.io/wallet/reference/json-rpc-api/) uses
133+
an internal plugin to import and parse OpenRPC
134134
specifications from [`MetaMask/api-specs`](https://github.com/MetaMask/api-specs) (MetaMask-specific
135135
methods) and [`ethereum/execution-apis`](https://github.com/ethereum/execution-apis) (standard
136136
Ethereum methods).
@@ -152,17 +152,33 @@ To update documentation for MetaMask-specific JSON-RPC API methods:
152152
2. Follow the repository's [`README.md`](https://github.com/MetaMask/api-specs/blob/main/README.md)
153153
instructions to edit the OpenRPC specification and generate the output file, `openrpc.json`.
154154

155-
3. To test the API updates in the MetaMask doc site's interactive reference, make the following
156-
temporary changes on a local branch of the doc site, `metamask-docs`:
155+
3. To test the API updates in the MetaMask doc site's interactive reference:
157156

158-
1. Copy and paste the output file `openrpc.json` into the root directory of `metamask-docs`.
159-
2. In `docusaurus.config.js`, update the following line to point to your local output file:
157+
1. Create and switch to a temporary local branch of the doc site, [`MetaMask/metamask-docs`](https://github.com/MetaMask/metamask-docs).
158+
For example, to create and switch to a branch named `test-api-updates`:
159+
```bash
160+
cd metamask-docs
161+
git checkout -b test-api-updates
162+
```
163+
2. Copy and paste the output file `openrpc.json` into the root directory of `metamask-docs`.
164+
3. Use [`http-server`](https://www.npmjs.com/package/http-server) to serve `openrpc.json` locally.
165+
Install `http-server` if you haven't yet, and start the server:
166+
```bash
167+
npm install --global http-server
168+
http-server
169+
```
170+
The `openrpc.json` file is now served at [`http://127.0.0.1:8080/openrpc.json`](http://127.0.0.1:8080/openrpc.json).
171+
4. In `src/plugins/plugin-json-rpc.ts`, update the following line to point to the locally served `openrpc.json` file:
160172
```diff
161-
openrpcDocument:
162-
- "https://metamask.github.io/api-specs/0.10.5/openrpc.json",
163-
+ "./openrpc.json",
173+
- export const MM_RPC_URL = "https://metamask.github.io/api-specs/latest/openrpc.json";
174+
+ export const MM_RPC_URL = "http://127.0.0.1:8080/openrpc.json";
175+
```
176+
5. In a new terminal window, preview the doc site locally:
177+
```bash
178+
cd metamask-docs
179+
npm start
164180
```
165-
3. Preview the doc site locally, navigate to the API reference, and view your updates.
181+
6. Navigate to the API reference, and view your updates.
166182
167183
4. Add and commit your changes to `api-specs`, and create a PR.
168184
@@ -180,14 +196,6 @@ To update documentation for MetaMask-specific JSON-RPC API methods:
180196
For example:
181197
> @metamask-npm-publishers `@metamask/[email protected]` is awaiting deployment :rocketship:
182198
https://github.com/MetaMask/api-specs/actions/runs/10615788573
183-
3. Once the release is published on npm, `docusaurus.config.js` in `metamask-docs` must be
184-
updated with the new `api-specs` version to publish.
185-
For example:
186-
```diff
187-
openrpcDocument:
188-
- "https://metamask.github.io/api-specs/0.10.5/openrpc.json",
189-
+ "https://metamask.github.io/api-specs/0.10.6/openrpc.json",
190-
```
191199
192200
### Update `ethereum/execution-apis`
193201
@@ -204,17 +212,8 @@ To update documentation for standard Ethereum JSON-RPC API methods:
204212
2. Follow the repository's [`README.md`](https://github.com/ethereum/execution-apis/blob/main/README.md)
205213
instructions to edit the OpenRPC specification and generate the output file, `openrpc.json`.
206214

207-
3. To test the API updates in the MetaMask doc site's interactive reference, make the following
208-
temporary changes on a local branch of the doc site, `metamask-docs`:
209-
210-
1. Copy and paste the output file `openrpc.json` into the root directory of `metamask-docs`.
211-
2. In `docusaurus.config.js`, update the following line to point to your local output file:
212-
```diff
213-
openrpcDocument:
214-
- "https://metamask.github.io/api-specs/0.10.5/openrpc.json",
215-
+ "./openrpc.json",
216-
```
217-
3. Preview the doc site locally, navigate to the API reference, and view your updates.
215+
3. To test the API updates in the MetaMask doc site's interactive reference, complete Step 3 in
216+
[Update `MetaMask/api-specs`](#update-metamaskapi-specs).
218217
219218
4. Add and commit your changes to `execution-apis`, and create a PR.
220219

docs/whats-new.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,11 @@ of the [MetaMask developer page](https://metamask.io/developer/).
1111

1212
## April 2025
1313

14+
- Documented [Ethereum Hoodi testnet](/services/get-started/endpoints/#ethereum) support. ([#1977](https://github.com/MetaMask/metamask-docs/pull/1977))
15+
- Documented [how to use deeplinks](/sdk/guides/use-deeplinks).
16+
([#1928](https://github.com/MetaMask/metamask-docs/pull/1928))
17+
- Documented [MetaMask SDK + Dynamic SDK integration](/sdk/quickstart/javascript-dynamic).
18+
([#1972](https://github.com/MetaMask/metamask-docs/pull/1972))
1419
- Documented [Snaps bundle analyzer option](/snaps/reference/cli/subcommands/#analyze).
1520
([#1955](https://github.com/MetaMask/metamask-docs/pull/1955))
1621

package-lock.json

Lines changed: 36 additions & 36 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
"@mdx-js/react": "^3.1.0",
4040
"@metamask/design-tokens": "^5.0.0",
4141
"@metamask/eth-sig-util": "^7.0.3",
42-
"@metamask/profile-sync-controller": "^11.0.0",
42+
"@metamask/profile-sync-controller": "^11.0.1",
4343
"@metamask/sdk": "^0.32.0",
4444
"@rjsf/core": "^5.24.1",
4545
"@rjsf/utils": "^5.24.8",
@@ -81,7 +81,7 @@
8181
"@tsconfig/docusaurus": "^2.0.3",
8282
"@types/react-alert": "^7.0.6",
8383
"@types/react-modal": "^3.16.3",
84-
"@typescript-eslint/parser": "^8.26.1",
84+
"@typescript-eslint/parser": "^8.30.1",
8585
"eslint": "^9.20.0",
8686
"eslint-plugin-react": "^7.37.4",
8787
"stylelint": "^15.0.0 ",

sdk-sidebar.js

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ const sidebar = {
66
{
77
type: 'category',
88
label: 'Introduction',
9-
collapsible: false,
9+
collapsible: false,
1010
collapsed: false,
1111
items: [
1212
'introduction/welcome',
@@ -23,28 +23,30 @@ const sidebar = {
2323
{
2424
type: 'category',
2525
label: 'Quickstart',
26-
collapsible: false,
26+
collapsible: false,
2727
collapsed: false,
2828
items: [
2929
'quickstart/javascript-wagmi',
3030
'quickstart/javascript',
31+
'quickstart/javascript-dynamic',
3132
'quickstart/react-native',
3233
],
3334
},
3435
{
3536
type: 'category',
3637
label: 'Guides',
37-
collapsible: false,
38+
collapsible: false,
3839
collapsed: false,
3940
items: [
4041
'guides/authenticate-users',
4142
'guides/manage-networks',
4243
'guides/handle-transactions',
4344
'guides/interact-with-contracts',
45+
'guides/use-deeplinks',
4446
{
4547
type: 'category',
4648
label: 'Advanced',
47-
collapsible: true,
49+
collapsible: true,
4850
collapsed: true,
4951
items: [
5052
'guides/advanced/connect-and-sign',
@@ -57,13 +59,11 @@ const sidebar = {
5759
{
5860
type: 'category',
5961
label: 'Reference',
60-
collapsible: false,
62+
collapsible: false,
6163
collapsed: false,
62-
items: [
63-
'reference/sdk-options'
64-
],
65-
}
64+
items: ['reference/sdk-options'],
65+
},
6666
],
67-
};
67+
}
6868

69-
module.exports = sidebar;
69+
module.exports = sidebar

0 commit comments

Comments
 (0)