-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
SDK section improvements #2064
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
SDK section improvements #2064
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR refines the SDK documentation by collapsing the Introduction sidebar, renaming the Quickstart section to “Connect to MetaMask,” updating guide titles/links accordingly, and adding a cross-platform callout to the Wallet API connect guide.
- Streamline the SDK Introduction category (remove Welcome, point its link to index)
- Rename Quickstart to “Connect to MetaMask” across sidebar, links, and headings
- Insert a tip highlighting the SDK for cross-platform/mobile integration in the Wallet API guide
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.
Show a summary per file
File | Description |
---|---|
wallet/how-to/connect.md | Updated the front-matter description and added an SDK tip callout |
sdk/index.md | Removed sidebar_label, changed quickstart links to connect pages |
sdk/connect/react-native.md | Added sidebar_label and updated H1 to match Connect to MetaMask theme |
sdk/connect/javascript.md | Added sidebar_label and updated H1 to match Connect to MetaMask theme |
sdk/connect/javascript-web3auth.md | Updated sidebar_label and H1 to match Connect to MetaMask theme |
sdk/connect/javascript-wagmi.md | Added sidebar_label and updated H1 to match Connect to MetaMask theme |
sdk/connect/javascript-dynamic.md | Updated sidebar_label and H1 to match Connect to MetaMask theme |
sdk-sidebar.js | Pointed the Introduction link to index and renamed Quickstart category items |
Comments suppressed due to low confidence (7)
sdk/index.md:6
- This page is missing an H1 title. Consider adding a top-level heading (e.g.,
# Introduction to MetaMask SDK
) immediately after the front matter for clarity and accessibility.
With the SDK, you can:
sdk/connect/react-native.md:2
- The front matter description still calls this a “Quickstart” guide; consider updating it to “Connect to MetaMask using React Native” to match the renamed category and H1.
description: Quickstart guide for using the SDK with a React Native dapp.
sdk/connect/javascript.md:2
- Update the description to reflect the new “Connect to MetaMask using JavaScript” title instead of “Quickstart.”
description: Quickstart guide for using the SDK with a JavaScript dapp.
sdk/connect/javascript-web3auth.md:3
- The description still mentions “Quickstart”; consider changing it to “Connect to MetaMask using Web3Auth SDK” to stay consistent with the updated H1.
description: Quickstart guide for using MetaMask SDK and Web3Auth SDK.
sdk/connect/javascript-wagmi.md:2
- This front matter still calls out “Quickstart”; update it to reflect “Connect to MetaMask using JavaScript + Wagmi.”
description: Quickstart guide for using the SDK with a JavaScript and Wagmi dapp.
sdk/connect/javascript-dynamic.md:3
- Consider updating the description to “Connect to MetaMask using Dynamic SDK” to match the new page title.
description: Quickstart guide for using MetaMask SDK and Dynamic SDK.
sdk-sidebar.js:13
- Verify that the doc ID "index" matches the actual generated ID for
sdk/index.md
. If the default ID issdk/index
, this link may break—update it to the correct ID.
id: "index"
Hey @alexandratran Any reason to have these as two different pages, as these are already covered in the Introduction.
* It works on multiple dapp platforms:
* Web dapps - Connect to the MetaMask browser extension or use QR codes to connect to MetaMask Mobile.
* Mobile dapps - Use deeplinks to connect to MetaMask Mobile.
* It works with all EVM-compatible L1/L2 networks. |
This was part of the original SDK docs revamp as designed by @chakra-guy and SDK team – I think it is meant to expand on and highlight the cross-platform functionality of the SDK. We can discuss in our next docs sync if it would be better to consolidate these pages. |
Description
First pass at attempting to drive more traffic to SDK intro page + connect guides. Major changes include:
/wallet/how-to/connect
to/sdk
. (Renamed/wallet/how-to/connect
to/wallet/how-to/connect-extension
.)Preview
https://metamask-docs-ltf2hxs9o-consensys-ddffed67.vercel.app/sdk/
Checklist
Complete this checklist before merging your PR: