Skip to content

Commit 57ad82c

Browse files
yashovardhanyashovardhan
authored
Merge pull request #1071 from Web3Auth/checklist
Add Integration Checklist
2 parents d38b33c + e8f0b80 commit 57ad82c

File tree

13 files changed

+1405
-205
lines changed

13 files changed

+1405
-205
lines changed

‎docs/checklist.mdx‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: Web3Auth Integration Checklist
3+
sidebar_label: Integration Checklist
4+
description: "Web3Auth Integration Checklist | Documentation - Web3Auth"
5+
hide_table_of_contents: true
6+
---
7+
8+
import Checklist from "@site/src/components/Checklist";
9+
10+
<Checklist
11+
showProductFilter={true}
12+
showPlatformFilter={true}
13+
showBlockchainFilter={true}
14+
showFeatureFilter={true}
15+
/>

‎docs/going-live.mdx‎

Lines changed: 0 additions & 177 deletions
This file was deleted.

‎docusaurus.config.ts‎

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,28 @@
1-
const path = require("path");
2-
require("dotenv").config();
1+
import path from "path";
2+
import dotenv from "dotenv";
3+
4+
import remarkMath from "remark-math";
5+
import rehypeKatex from "rehype-katex";
6+
import fs from "fs";
7+
import { themes } from "prism-react-renderer";
8+
import type { Config } from "@docusaurus/types";
9+
import type * as Preset from "@docusaurus/preset-classic";
10+
import npm2yarn from "@docusaurus/remark-plugin-npm2yarn";
11+
const sidebarPath = require.resolve("./sidebars");
12+
const customCss = require.resolve("./src/css/custom.css");
13+
// Initialize dotenv
14+
dotenv.config();
15+
316
const githubOrg = "web3auth";
417
const githubRepo = "web3auth-docs";
518
const githubOrgUrl = `https://github.com/${githubOrg}`;
619
const githubRepoUrl = `${githubOrgUrl}/${githubRepo}`;
720
const githubEditUrl = `${githubRepoUrl}/edit/master`;
8-
const remarkMath = require("remark-math");
9-
const rehypeKatex = require("rehype-katex");
10-
const fs = require("fs");
1121
const baseUrl = process.env.REACT_APP_BASE_URL || "/docs/";
12-
const { themes } = require("prism-react-renderer");
1322

1423
const resourcesDropdown = fs.readFileSync("./src/components/navDropdown/resources.html", "utf-8");
1524
const helpDropdown = fs.readFileSync("./src/components/navDropdown/help.html", "utf-8");
1625
const sdkDropdown = fs.readFileSync("./src/components/navDropdown/sdk.html", "utf-8");
17-
import type { Config } from "@docusaurus/types";
18-
import type * as Preset from "@docusaurus/preset-classic";
1926

2027
const config: Config = {
2128
title: "Documentation | Web3Auth",
@@ -194,15 +201,12 @@ const config: Config = {
194201
routeBasePath: "/",
195202
breadcrumbs: true,
196203
editUrl: githubEditUrl,
197-
sidebarPath: require.resolve("./sidebars.js"),
198-
remarkPlugins: [
199-
remarkMath,
200-
[require("@docusaurus/remark-plugin-npm2yarn"), { sync: true }],
201-
],
204+
sidebarPath,
205+
remarkPlugins: [remarkMath, [npm2yarn, { sync: true }]],
202206
rehypePlugins: [[rehypeKatex, { strict: false }]],
203207
},
204208
theme: {
205-
customCss: require.resolve("./src/css/custom.css"),
209+
customCss,
206210
},
207211
gtag: {
208212
trackingID: "GTM-NFBSNHL",
@@ -218,10 +222,7 @@ const config: Config = {
218222
"**/__tests__/**",
219223
],
220224
mdxPageComponent: "@theme/MDXPage",
221-
remarkPlugins: [
222-
remarkMath,
223-
[require("@docusaurus/remark-plugin-npm2yarn"), { sync: true }],
224-
],
225+
remarkPlugins: [remarkMath, [npm2yarn, { sync: true }]],
225226
rehypePlugins: [[rehypeKatex, { strict: false }]],
226227
beforeDefaultRemarkPlugins: [],
227228
beforeDefaultRehypePlugins: [],
@@ -498,11 +499,11 @@ const config: Config = {
498499
},
499500
{
500501
from: "/pnp/going-live",
501-
to: "/going-live",
502+
to: "/checklist",
502503
},
503504
{
504505
from: "/core-kit/going-live",
505-
to: "/going-live",
506+
to: "/checklist",
506507
},
507508
{
508509
from: "/auth-provider-setup/federated-identity-providers",

‎package-lock.json‎

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

‎package.json‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,5 +100,8 @@
100100
"**/*.{md,mdx}": [
101101
"prettier --write"
102102
]
103+
},
104+
"engines": {
105+
"node": ">=18.0"
103106
}
104107
}

‎sidebars.ts‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -249,6 +249,20 @@ const sidebars: SidebarsConfig = {
249249
</a>`,
250250
defaultStyle: true,
251251
},
252+
{
253+
type: "html",
254+
value: `<a class='sidebarLink' href="/docs/checklist">
255+
256+
<svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg">
257+
<path d="M9 2C8.73478 2 8.48043 2.10536 8.29289 2.29289C8.10536 2.48043 8 2.73478 8 3C8 3.26522 8.10536 3.51957 8.29289 3.70711C8.48043 3.89464 8.73478 4 9 4H11C11.2652 4 11.5196 3.89464 11.7071 3.70711C11.8946 3.51957 12 3.26522 12 3C12 2.73478 11.8946 2.48043 11.7071 2.29289C11.5196 2.10536 11.2652 2 11 2H9Z" fill="currentColor"/>
258+
<path fill-rule="evenodd" clip-rule="evenodd" d="M4 5C4 4.46957 4.21071 3.96086 4.58579 3.58579C4.96086 3.21071 5.46957 3 6 3C6 3.79565 6.31607 4.55871 6.87868 5.12132C7.44129 5.68393 8.20435 6 9 6H11C11.7956 6 12.5587 5.68393 13.1213 5.12132C13.6839 4.55871 14 3.79565 14 3C14.5304 3 15.0391 3.21071 15.4142 3.58579C15.7893 3.96086 16 4.46957 16 5V16C16 16.5304 15.7893 17.0391 15.4142 17.4142C15.0391 17.7893 14.5304 18 14 18H6C5.46957 18 4.96086 17.7893 4.58579 17.4142C4.21071 17.0391 4 16.5304 4 16V5ZM13.707 10.707C13.8892 10.5184 13.99 10.2658 13.9877 10.0036C13.9854 9.7414 13.8802 9.49059 13.6948 9.30518C13.5094 9.11977 13.2586 9.0146 12.9964 9.01233C12.7342 9.01005 12.4816 9.11084 12.293 9.293L9 12.586L7.707 11.293C7.5184 11.1108 7.2658 11.01 7.0036 11.0123C6.7414 11.0146 6.49059 11.1198 6.30518 11.3052C6.11977 11.4906 6.0146 11.7414 6.01233 12.0036C6.01005 12.2658 6.11084 12.5184 6.293 12.707L8.293 14.707C8.48053 14.8945 8.73484 14.9998 9 14.9998C9.26516 14.9998 9.51947 14.8945 9.707 14.707L13.707 10.707Z" fill="currentColor"/>
259+
</svg>
260+
261+
262+
<span class='sidebarLinkText'>Integration Checklist</span>
263+
</a>`,
264+
defaultStyle: true,
265+
},
252266
{
253267
type: "html",
254268
value: "<span class='sidebarHeading'>Overview</span>",
@@ -401,6 +415,20 @@ const sidebars: SidebarsConfig = {
401415
</a>`,
402416
defaultStyle: true,
403417
},
418+
{
419+
type: "html",
420+
value: `<a class='sidebarLink' href="/docs/checklist">
421+
422+
<svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg">
423+
<path d="M9 2C8.73478 2 8.48043 2.10536 8.29289 2.29289C8.10536 2.48043 8 2.73478 8 3C8 3.26522 8.10536 3.51957 8.29289 3.70711C8.48043 3.89464 8.73478 4 9 4H11C11.2652 4 11.5196 3.89464 11.7071 3.70711C11.8946 3.51957 12 3.26522 12 3C12 2.73478 11.8946 2.48043 11.7071 2.29289C11.5196 2.10536 11.2652 2 11 2H9Z" fill="currentColor"/>
424+
<path fill-rule="evenodd" clip-rule="evenodd" d="M4 5C4 4.46957 4.21071 3.96086 4.58579 3.58579C4.96086 3.21071 5.46957 3 6 3C6 3.79565 6.31607 4.55871 6.87868 5.12132C7.44129 5.68393 8.20435 6 9 6H11C11.7956 6 12.5587 5.68393 13.1213 5.12132C13.6839 4.55871 14 3.79565 14 3C14.5304 3 15.0391 3.21071 15.4142 3.58579C15.7893 3.96086 16 4.46957 16 5V16C16 16.5304 15.7893 17.0391 15.4142 17.4142C15.0391 17.7893 14.5304 18 14 18H6C5.46957 18 4.96086 17.7893 4.58579 17.4142C4.21071 17.0391 4 16.5304 4 16V5ZM13.707 10.707C13.8892 10.5184 13.99 10.2658 13.9877 10.0036C13.9854 9.7414 13.8802 9.49059 13.6948 9.30518C13.5094 9.11977 13.2586 9.0146 12.9964 9.01233C12.7342 9.01005 12.4816 9.11084 12.293 9.293L9 12.586L7.707 11.293C7.5184 11.1108 7.2658 11.01 7.0036 11.0123C6.7414 11.0146 6.49059 11.1198 6.30518 11.3052C6.11977 11.4906 6.0146 11.7414 6.01233 12.0036C6.01005 12.2658 6.11084 12.5184 6.293 12.707L8.293 14.707C8.48053 14.8945 8.73484 14.9998 9 14.9998C9.26516 14.9998 9.51947 14.8945 9.707 14.707L13.707 10.707Z" fill="currentColor"/>
425+
</svg>
426+
427+
428+
<span class='sidebarLinkText'>Integration Checklist</span>
429+
</a>`,
430+
defaultStyle: true,
431+
},
404432
{
405433
type: "html",
406434
value: "<span class='sidebarHeading'>Resources</span>",
@@ -1119,6 +1147,7 @@ const sidebars: SidebarsConfig = {
11191147
],
11201148
},
11211149
"examples",
1150+
"checklist",
11221151
{
11231152
type: "category",
11241153
label: "Web3Auth Infrastructure",

‎src/common/hostedFileLinks.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@
143143
"MPC_CORE_KIT_REACT_NATIVE_PACKAGE_JSON": "Web3Auth/web3auth-core-kit-examples/main/mpc-core-kit-react-native/mpc-core-kit-rn-quick-start/package.json",
144144
"MPC_CORE_KIT_REACT_NATIVE_APP_TSX": "Web3Auth/web3auth-core-kit-examples/main/mpc-core-kit-react-native/mpc-core-kit-rn-quick-start/App.tsx",
145145
"MPC_CORE_KIT_REACT_NATIVE_METRO_CONFIG_JS": "Web3Auth/web3auth-core-kit-examples/main/mpc-core-kit-react-native/mpc-core-kit-rn-quick-start/metro.config.js",
146-
"MPC_CORE_KIT_REACT_NATIVE_GLOBALS_JS": "Web3Auth/web3auth-core-kit-examples/main/mpc-core-kit-react-native/mpc-core-kit-rn-quick-start/globals.js",
146+
"MPC_CORE_KIT_REACT_NATIVE_GLOBALS_JS": "Web3Auth/web3auth-core-kit-examples/main/mpc-core-kit-react-native/mpc-core-kit-rn-quick-start/globals.ts",
147147
"MPC_CORE_KIT_REACT_NATIVE_INDEX_JS": "Web3Auth/web3auth-core-kit-examples/main/mpc-core-kit-react-native/mpc-core-kit-rn-quick-start/index.js",
148148
"MPC_CORE_KIT_REACT_NATIVE_BUILD_GRADLE": "Web3Auth/web3auth-core-kit-examples/main/mpc-core-kit-react-native/mpc-core-kit-rn-quick-start/android/build.gradle",
149149
"MPC_CORE_KIT_REACT_NATIVE_PODFILE": "Web3Auth/web3auth-core-kit-examples/main/mpc-core-kit-react-native/mpc-core-kit-rn-quick-start/ios/Podfile",

0 commit comments

Comments
 (0)