Skip to content

Commit

Permalink
initial updates
Browse files Browse the repository at this point in the history
  • Loading branch information
alexandratran committed Jul 18, 2024
1 parent 04980a9 commit e44d361
Show file tree
Hide file tree
Showing 19 changed files with 45 additions and 281 deletions.
4 changes: 2 additions & 2 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ const config = {
},
{
to: "wallet",
label: "Wallet",
label: "Wallet API",
},
{
to: "snaps",
Expand Down Expand Up @@ -265,7 +265,7 @@ const config = {
to: "/sdk",
},
{
label: "Wallet",
label: "Wallet API",
to: "/wallet",
},
{
Expand Down
18 changes: 3 additions & 15 deletions sdk-sidebar.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,9 @@ const sidebar = {
{
type: "category",
label: "Get started",
link: { type: "generated-index", slug: "/get-started" },
link: {
type: "generated-index",
slug: "/get-started", },
collapsed: false,
items: [{ type: "autogenerated", dirName: "get-started" }],
},
Expand All @@ -31,20 +33,6 @@ const sidebar = {
collapsed: false,
items: [{ type: "autogenerated", dirName: "how-to" }],
},
{
type: "category",
label: "Concepts",
link: { type: "generated-index", slug: "/concepts" },
collapsed: false,
items: [{ type: "autogenerated", dirName: "concepts" }],
},
{
type: "category",
label: "Tutorials",
link: { type: "generated-index", slug: "/tutorials" },
collapsed: false,
items: [{ type: "autogenerated", dirName: "tutorials" }],
},
{
type: "category",
label: "Reference",
Expand Down
170 changes: 0 additions & 170 deletions sdk/concepts/about-sdk.md

This file was deleted.

2 changes: 1 addition & 1 deletion sdk/get-started/gaming/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_label: Gaming
sidebar_position: 4
sidebar_position: 5
description: Set up the SDK in your gaming dapp.
---

Expand Down
2 changes: 1 addition & 1 deletion sdk/get-started/javascript/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_label: JavaScript
sidebar_position: 2
sidebar_position: 3
description: Set up the SDK in your JavaScript dapp.
---

Expand Down
2 changes: 1 addition & 1 deletion sdk/get-started/mobile/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_label: Mobile
sidebar_position: 3
sidebar_position: 4
description: Set up the SDK in your mobile dapp.
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_label: React Native and Expo
sidebar_position: 4
sidebar_position: 3
description: Set up the SDK in your React Native dapp.
---

Expand Down
9 changes: 9 additions & 0 deletions sdk/get-started/multi-wallet-connectors/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
sidebar_label: Multi-wallet connectors
sidebar_position: 2
description: Set up the SDK using multi-wallet connectors.
---

# Multi-wallet connectors

Coming soon.
8 changes: 0 additions & 8 deletions sdk/how-to/mobile/_category_.json

This file was deleted.

8 changes: 0 additions & 8 deletions sdk/how-to/mobile/android/_category_.json

This file was deleted.

2 changes: 0 additions & 2 deletions sdk/how-to/mobile/android/connect-and-sign.md

This file was deleted.

8 changes: 0 additions & 8 deletions sdk/how-to/mobile/ios/_category_.json

This file was deleted.

1 change: 0 additions & 1 deletion sdk/how-to/mobile/ios/connect-and-sign.md

This file was deleted.

78 changes: 24 additions & 54 deletions sdk/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,63 +5,33 @@ description: Use the SDK in your dapp.

# MetaMask SDK documentation

[MetaMask SDK](concepts/about-sdk.md) is a library that provides a reliable, secure, and seamless
connection from your dapp to the MetaMask browser extension and MetaMask Mobile.
MetaMask SDK is a library that provides a reliable, secure, and seamless connection from your dapp
to the MetaMask browser extension and MetaMask Mobile.
You can install the SDK in existing dapps, and call any [Wallet API](/wallet) methods from your dapp.

## Why MetaMask SDK?

MetaMask SDK enables your dapp to provide a seamless user experience for MetaMask users, from
multiple dapp platforms, without relying on third-party libraries.
By integrating your dapp using the SDK, millions of MetaMask Mobile users can connect to their
preferred MetaMask client.
The SDK supports the following dapp platforms:
The SDK uses the [MetaMask Ethereum provider](/wallet/concepts/wallet-api/#ethereum-provider-api),
so existing dapps work out of the box with the SDK.

The following table outlines some of the features available when you integrate your dapp with
MetaMask using the SDK.
Most of these features are not available if you only integrate your dapp directly using the
[Wallet API](/wallet).

<div class="cards">
<div class="card">
<div class="card__header">
<h3>💻 <a href="get-started/javascript">JavaScript</a></h3>
</div>
<div class="card__body">
<ul>
<li><a href="get-started/javascript/react">React</a></li>
<li><a href="get-started/javascript/pure-js">Pure JavaScript</a></li>
<li><a href="get-started/javascript/other-web-frameworks">Other web frameworks</a></li>
<li><a href="get-started/javascript/react-native">React Native</a></li>
<li><a href="get-started/javascript/nodejs">Node.js</a></li>
<li><a href="get-started/javascript/electron">Electron</a></li>
</ul>
</div>
</div>
<div class="card">
<div class="card__header">
<h3>📱 <a href="get-started/mobile">Mobile</a></h3>
</div>
<div class="card__body">
<ul>
<li><a href="get-started/javascript/react-native">React Native</a></li>
<li><a href="get-started/mobile/ios">iOS</a></li>
<li><a href="get-started/mobile/android">Android</a></li>
</ul>
</div>
</div>
<div class="card">
<div class="card__header">
<h3>🎮 <a href="get-started/gaming">Gaming</a></h3>
</div>
<div class="card__body">
<ul>
<li><a href="get-started/gaming/unity">Unity</a></li>
<li>Unreal Engine (coming soon)</li>
</ul>
</div>
</div>
</div>
<div class="card margin-bottom--lg">
<div class="card__header">
<h3>↔️ <a href="get-started/3rd-party-libraries">Third-party libraries</a></h3>
</div>
<div class="card__body">
<ul>
<li><a href="get-started/3rd-party-libraries/web3-onboard">Web3-Onboard</a></li>
<li><a href="get-started/3rd-party-libraries/wagmi">Wagmi</a></li>
</ul>
</div>
</div>
| Feature | Wallet API only | MetaMask SDK |
|-----------------------------------------------------------------------------------------------| :-------------: | :----------: |
| Connect from a web dapp to the MetaMask extension |||
| Connect from a web dapp to MetaMask Mobile |||
| Connect from desktop, mobile, and gaming dapps to MetaMask Mobile |||
| Use custom RPC methods such as [`connectAndSign`](how-to/javascript/connect-and-sign.md) |||
| [Display custom modals](how-to/javascript/display-custom-modals.md) in MetaMask |||
| [Make read-only requests](how-to/javascript/make-read-only-requests.md) using the Infura API |||
| [Batch multiple RPC requests](how-to/javascript/batch-json-rpc-requests.md) |||

## Questions?

Expand Down
2 changes: 1 addition & 1 deletion sdk/concepts/android.md → sdk/reference/android.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 3
sidebar_position: 4
description: Learn about the Android SDK architecture.
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 2
sidebar_position: 3
sidebar_label: SDK connections
description: Learn about how a dapp with the SDK installed connects to MetaMask.
---
Expand Down
Loading

0 comments on commit e44d361

Please sign in to comment.