Skip to content
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

SDK: New Docs #1766

Draft
wants to merge 17 commits into
base: main
Choose a base branch
from
Draft

SDK: New Docs #1766

wants to merge 17 commits into from

Conversation

chakra-guy
Copy link

@chakra-guy chakra-guy commented Dec 4, 2024

Description

This PR restructures the MetaMask documentation to clearly separate the Wallet API from the SDK. Historically, both lived under a single “Wallet” section because they addressed similar needs (interacting with the MetaMask wallet). However, the SDK’s future scope now extends well beyond wallet connectivity—it’s evolving into a broader toolkit for building on-chain applications, connecting to multiple wallets, and integrating other Web3 services (e.g., on-ramps, swaps, smart accounts, and embedded wallets).

By splitting the Wallet API and the SDK into distinct sections, we create a more intuitive navigation and mental model for developers. Going forward, the Wallet API remains focused solely on the MetaMask Wallet itself, while the SDK becomes a fully versioned, standalone developer toolkit encompassing multiple modules.

Key changes:

  • Top-level Restructure: Introduces separate top-level sections for the Wallet API and the SDK instead of a single “Wallet” section.
  • Homepage Update: The documentation homepage now routes developers directly to the product area they need (e.g., Snaps, Wallet API, SDK), making it easier to identify the relevant path from the start.
  • Wallet API Section: Retains and refines existing Wallet API content, removing or redirecting any SDK-related references.
  • SDK Section: Establishes a new SDK structure, pulled from and expanded beyond the original Wallet docs. This includes organizing content around the broader on-chain application development toolkit vision.
  • Versioning Ready: Splitting the two makes it straightforward to introduce versioning to the SDK without confusing Wallet API users or mixing product lifecycles.
  • Vercel Redirects: Vercel redirect links have been updated to account for the split.

Issue(s) fixed

Fixes # (Add issue number if applicable)

Preview

(Include a preview link to the updated docs if available)

Checklist

  • If this PR contains a major change to documentation content, add an entry to the top of the "What's new?" page.
  • Changes reviewed and approved by a member of the documentation team.

Copy link

vercel bot commented Dec 4, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
metamask-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 20, 2024 2:22pm

@chakra-guy chakra-guy changed the title refactor(sdk) SDK: New Structure Dec 18, 2024
@chakra-guy chakra-guy changed the title SDK: New Structure SDK: New Docs Dec 18, 2024
sdk/guides/user-authentication.md Outdated Show resolved Hide resolved
sdk/guides/network-management.md Outdated Show resolved Hide resolved
sdk-sidebar.js Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants