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
19 changes: 19 additions & 0 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,17 @@ const config = {
}
},
],
[
"@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"),
breadcrumbs: false,
},
],
"./src/plugins/plugin-json-rpc.ts",
isProd
? [
Expand Down Expand Up @@ -182,6 +193,10 @@ const config = {
to: "wallet",
label: "Wallet",
},
{
to: "sdk",
label: "SDK",
},
{
to: "snaps",
label: "Snaps",
Expand Down Expand Up @@ -248,6 +263,10 @@ const config = {
label: "Wallet",
to: "/wallet",
},
{
label: "SDK",
to: "/sdk",
},
{
label: "Snaps",
to: "/snaps",
Expand Down
78 changes: 78 additions & 0 deletions sdk-sidebar.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
// @ts-check

/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebar = {
sdkSidebar: [
{
type: 'category',
label: 'Introduction',
collapsible: false,
collapsed: false,
items: [
'introduction/welcome',
'introduction/supported-platforms',
'introduction/supported-networks',
'introduction/llm-prompt',
{
type: 'link',
label: 'Try Demo App',
href: 'https://example.com',
},
],
},
{
type: 'category',
label: 'Quick Start',
collapsible: false,
collapsed: false,
items: [
'quick-start/javascript-+-wagmi',
'quick-start/javascript',
'quick-start/react-native',
],
},
{
type: 'category',
label: 'Guides',
collapsible: false,
collapsed: false,
items: [
'guides/user-authentication',
'guides/network-management',
'guides/transaction-handling',
'guides/interact-with-contracts',
{
type: 'category',
label: 'Advanced',
collapsible: true,
collapsed: true,
items: [
'guides/advanced/connect-and-sign',
'guides/advanced/batch-requests',
],
},
],
},
{
type: 'category',
label: 'API Reference',
collapsible: false,
collapsed: false,
items: [
'api-reference/sdk-api',
{
type: 'link',
label: 'Provider API',
href: '/wallet/reference/provider-api',
},
{
type: 'link',
label: 'JSON-RPC API',
href: '/wallet/reference/json-rpc-methods',
},
chakra-guy marked this conversation as resolved.
Show resolved Hide resolved
],
}
],
};

module.exports = sidebar;
Binary file added sdk/_assets/quickstart-step-1.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added sdk/_assets/quickstart-step-2.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added sdk/_assets/quickstart-step-3.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added sdk/_assets/quickstart-step-4.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added sdk/_assets/quickstart-step-5.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added sdk/_assets/quickstart-step-6.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added sdk/_assets/quickstart-step-7.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added sdk/_assets/quickstart-step-8.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added sdk/_assets/quickstart-step-9.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added sdk/_assets/quickstart.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading