Skip to content

Commit 89c8c5d

Browse files
shahbaz17shahbaz17
authored
Merge pull request #655 from Web3Auth/docs-restructure
Docs restructure
2 parents 3f66961 + f407a17 commit 89c8c5d

File tree

411 files changed

+7896
-5139
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

411 files changed

+7896
-5139
lines changed

‎.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,5 @@ yarn-debug.log*
2020
yarn-error.log*
2121
.env
2222
.integrationBuilderCache
23+
24+
yarn.lock

‎.prettierrc.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"proseWrap": "always",
3-
"printWidth": 150,
3+
"printWidth": 100,
44
"singleQuote": false,
55
"semi": true
66
}

‎.vscode/settings.json

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55
"files.insertFinalNewline": true,
66
"editor.defaultFormatter": "esbenp.prettier-vscode",
77
// "editor.formatOnSave": true,
8-
98
// Misc
109
"javascript.suggestionActions.enabled": false,
1110
"cSpell.words": [
@@ -32,9 +31,23 @@
3231
],
3332
"editor.formatOnSave": true,
3433
"eslint.options": {
35-
"extensions": [".js", ".jsx", ".md", ".mdx", ".ts", ".tsx"]
34+
"extensions": [
35+
".js",
36+
".jsx",
37+
".md",
38+
".mdx",
39+
".ts",
40+
".tsx"
41+
]
3642
},
37-
"eslint.validate": ["markdown", "mdx", "javascript", "javascriptreact", "typescript", "typescriptreact"],
43+
"eslint.validate": [
44+
"markdown",
45+
"mdx",
46+
"javascript",
47+
"javascriptreact",
48+
"typescript",
49+
"typescriptreact"
50+
],
3851
"[mdx]": {
3952
"editor.defaultFormatter": "esbenp.prettier-vscode"
4053
},
@@ -46,5 +59,8 @@
4659
},
4760
"[typescriptreact]": {
4861
"editor.defaultFormatter": "vscode.typescript-language-features"
62+
},
63+
"[typescript]": {
64+
"editor.defaultFormatter": "esbenp.prettier-vscode"
4965
}
5066
}

‎docs/README.mdx

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,31 @@ import HelpCards from "@site/src/components/HelpCards";
1212
import HomeQuickStartBanner from "@site/src/components/HomeQuickStartBanner";
1313
import IntegrationBuilderBanner from "@site/src/components/IntegrationBuilderBanner";
1414
import ResourcesCards from "@site/src/components/ResourcesCards";
15-
// import SDKReferenceCards from "@site/src/components/SDKReferenceCards";
15+
import ProductCards from "@site/src/components/ProductCards";
1616
import SEO from "@site/src/components/SEO";
1717

1818
<SEO />
19+
20+
# Web3Auth Documentation
21+
22+
#### Simplifying User Onboarding with Scalable, Secure, Non-Custodial Wallet Management
23+
1924
<HomeQuickStartBanner />
20-
{/* <SDKReferenceCards /> */}
25+
26+
# Discover Our Solutions
27+
28+
Our extensive product suite covers everything from pre-onboarding to post-onboarding and authentication, enabling you to craft a seamless end-to-end
29+
experience for your Web3 dApp.
30+
31+
<ProductCards />
32+
33+
# Resources
34+
35+
Our comprehensive array of guides, reference materials, and examples is designed to assist you at every step of your Web3Auth integration. Explore the
36+
nuances of web3 authentication and craft a tailored integration that meets your specific needs.
37+
2138
<ResourcesCards />
22-
<IntegrationBuilderBanner />
39+
40+
# Need Help?
41+
2342
<HelpCards />

‎docs/auth-provider-setup/aggregate-verifier.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Creating Aggregate Verifier on the Web3Auth Dashboard
33
sidebar_label: Aggregate Verifier
4-
displayed_sidebar: docs
4+
displayed_sidebar: resources
55
description: "Creating Aggregate Verifier on the Web3Auth Dashboard | Documentation - Web3Auth"
66
image: "images/docs-meta-cards/documentation-card.png"
77
---
@@ -60,7 +60,6 @@ import { EthereumPrivateKeyProvider } from "@web3auth/ethereum-provider";
6060
const clientId = "BPi5PB_UiIZ-cPz1GtV5i1I2iOSOHuimiXBI0e-Oe_u6X3oVAbCiAZOTEBtTXw4tsluTITPqA8zMsfxIKMjiqNQ";
6161
// get it from https://dashboard.web3auth.io by creating a Plug n Play project.
6262

63-
6463
const chainConfig = {
6564
chainNamespace: "eip155",
6665
chainId: "0x1",
@@ -69,7 +68,7 @@ const chainConfig = {
6968
blockExplorerUrl: "https://etherscan.io",
7069
ticker: "ETH",
7170
tickerName: "Ethereum",
72-
logo: "https://images.toruswallet.io/ethereum.svg"
71+
logo: "https://images.toruswallet.io/ethereum.svg",
7372
};
7473

7574
const privateKeyProvider = new EthereumPrivateKeyProvider({ config: { chainConfig } });

‎docs/auth-provider-setup/auth-provider-setup.mdx

Lines changed: 31 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,55 @@
11
---
22
title: Auth Provider Setup
3+
sidebar_label: Overview
34
image: "images/docs-meta-cards/documentation-card.png"
4-
displayed_sidebar: docs
5+
displayed_sidebar: resources
56
description: "Auth Provider Setup | Documentation - Web3Auth"
67
---
78

89
import BYOCustomJWTTiles from "@site/src/common/docs/_byo-custom-jwt-providers.mdx";
910
import FederatedTiles from "@site/src/common/docs/_federated-providers.mdx";
1011
import SocialTiles from "@site/src/common/docs/_social-login-providers.mdx";
1112

12-
Auth Provider setup refers to the capability of creating a **verifier**(_a way to do custom authentication_) with Web3Auth. By default, Web3Auth comes
13-
with a set of default verifiers that you can use out of the box.
13+
Setting up authentication providers within Web3Auth is a crucial step in configuring the authentication flow for your application. This process
14+
involves creating a verifier, a unique identifier that Web3Auth uses to interact with the OAuth provider and validate user authentication requests.
15+
Verifiers play a pivotal role in ensuring secure and seamless authentication by leveraging the Web3Auth Auth Network nodes and a dedicated blockchain.
1416

15-
:::info Caveat with Default Verifiers
17+
## Understanding Verifiers
1618

17-
- **Migration from Default Verifiers to Custom Verifiers is not possible.**
18-
- The default verifier is not suitable for all use cases. For example, if you are using a custom JWT provider, you will need to use the
19-
[`Web3Auth Plug and Play No Modal SDK`](/sdk/pnp/web/no-modal/), since the Web3Auth Modal will only help you configure the social logins present
20-
within the Modal UI.
21-
- **Aggregation of the default verifier is not possible.** For example, if you want to aggregate Google and Email Passwordless, or any two/more social
22-
providers, you will need to create an Aggregate Verifier, which is not possible if you start with:
23-
- a Default Verifier
24-
- or, Social Login Providers
25-
- or, Custom Providers
19+
A verifier is essentially a configuration that contains information about the OAuth provider you've chosen for your application. It acts as a bridge
20+
between Web3Auth and the OAuth provider, enabling the Auth Network nodes to query and validate JWT tokens effectively.
21+
22+
:::tip
23+
24+
Head over to the [Verifiers](./verifiers.mdx) section to understand how to create a custom verifier for your application.
2625

2726
:::
2827

28+
## Setting Up Your Auth Provider
29+
30+
Integrating an OAuth provider with Web3Auth involves a few key steps, from selecting your provider to configuring the verifier and integrating it into
31+
your application. Here's a broad overview of the process:
32+
33+
1. **Select an OAuth Provider:** Choose an OAuth provider supported by Web3Auth, such as Google, Facebook, Twitter, or any other provider that fits
34+
your application's requirements.
35+
36+
2. **Create a Verifier:** Using the Web3Auth Dashboard, create a new verifier for your selected OAuth provider. This involves specifying the provider
37+
details and any additional configuration required by the provider.
38+
39+
3. **Deploy to the Web3Auth Blockchain:** Once your verifier is configured, it's deployed to the Web3Auth blockchain. This deployment process
40+
registers your verifier, making it accessible to the Auth Network nodes for JWT token verification. This process generally takes around 5-10
41+
minutes to complete.
42+
43+
4. **Integrate with Your Application:** Finally, integrate the verifier into your application's authentication flow. This typically involves utilizing
44+
Web3Auth SDKs and specifying the verifier details in your application's authentication setup.
45+
2946
## Supported Auth Providers
3047

3148
### Social
3249

3350
<SocialTiles />
3451

35-
### Federated / Identity Providers
52+
### Authentication Service Providers
3653

3754
<FederatedTiles />
3855

‎docs/auth-provider-setup/federated-identity-providers.mdx renamed to ‎docs/auth-provider-setup/authentication-service-providers.mdx

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,24 @@
11
---
2-
title: Federated / Identity Providers
3-
displayed_sidebar: docs
4-
description: "Federated / Identity Providers | Documentation - Web3Auth"
2+
title: Authentication Service Providers
3+
displayed_sidebar: resources
4+
description: "Authentication Service Providers | Documentation - Web3Auth"
55
image: "images/docs-meta-cards/documentation-card.png"
66
---
77

88
import SetupAWSCognitoVerifier from "@site/src/common/guides/_setup-aws-cognito-verifier.mdx";
99
import SetupFirebaseVerifier from "@site/src/common/guides/_setup-firebase-verifier.mdx";
1010

11-
Federated / Identity providers enable you to use some implicit and authorization code grants. You could also use social providers on top of Federated
12-
/ Identity providers to select other Social providers (e.g.: Twitter, Apple, GitHub, LinkedIn, WeChat etc.) that are not natively supported by us.
13-
Note: This will require you to register an app with the Federated / Identity Providers.
11+
Authentication Service Providers enable you to use some implicit and authorization code grants. You could also use social providers on top of
12+
Federated / Identity providers to select other Social providers (e.g.: Twitter, Apple, GitHub, LinkedIn, WeChat etc.) that are not natively supported
13+
by us. Note: This will require you to register an app with the Authentication Service Providers.
1414

15-
## Auth0
15+
This guide will help you to set up the following Authentication Service Providers:
16+
17+
- [Auth0](#auth0)
18+
- [AWS Cognito](#aws-cognito)
19+
- [Firebase](#firebase)
1620

17-
### Set up Auth0 Verifier
21+
## Auth0
1822

1923
1. Create an Auth0 verifier by choosing `Social Login Providers` and selecting `Auth0` from the **Login Provider** dropdown.
2024
![Auth0 - Login Providers list on Web3Auth Dashboard](/dashboard/verifiers/create-auth0-verifier.png)
@@ -42,8 +46,6 @@ Check out the [**Auth0 guide**](/guides/auth0) to learn more about how to set up
4246

4347
## AWS Cognito
4448

45-
### Set up AWS Cognito Verifier
46-
4749
<SetupAWSCognitoVerifier />
4850

4951
:::info Guide
@@ -54,8 +56,6 @@ Check out the [** AWS Cognito guide**](/guides/cognito) to learn more about how
5456

5557
## Firebase
5658

57-
### Setup Firebase Verifier
58-
5959
<SetupFirebaseVerifier />
6060

6161
:::info Guide

‎docs/auth-provider-setup/byo-jwt-providers.mdx renamed to ‎docs/auth-provider-setup/byo-jwt-provider.mdx

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Bring your own custom JWT Providers
3-
displayed_sidebar: docs
4-
description: "Bring your own custom JWT Providers | Documentation - Web3Auth"
2+
title: Bring your own custom JWT Provider
3+
displayed_sidebar: resources
4+
description: "Bring your own custom JWT Provider | Documentation - Web3Auth"
55
image: "images/docs-meta-cards/documentation-card.png"
66
---
77

@@ -197,10 +197,9 @@ const chainConfig = {
197197
blockExplorerUrl: "https://etherscan.io",
198198
ticker: "ETH",
199199
tickerName: "Ethereum",
200-
logo: "https://images.toruswallet.io/ethereum.svg"
200+
logo: "https://images.toruswallet.io/ethereum.svg",
201201
};
202202

203-
204203
const privateKeyProvider = new EthereumPrivateKeyProvider({ config: { chainConfig } });
205204

206205
const web3auth = new Web3AuthNoModal({
@@ -210,7 +209,6 @@ const web3auth = new Web3AuthNoModal({
210209
useCoreKitKey: false,
211210
});
212211

213-
214212
const openloginAdapter = new OpenloginAdapter({
215213
adapterSettings: {
216214
uxMode: "redirect", // redirect or popup
@@ -284,7 +282,7 @@ const chainConfig = {
284282
blockExplorerUrl: "https://etherscan.io",
285283
ticker: "ETH",
286284
tickerName: "Ethereum",
287-
logo: "https://images.toruswallet.io/ethereum.svg"
285+
logo: "https://images.toruswallet.io/ethereum.svg",
288286
};
289287

290288
const privateKeyProvider = new EthereumPrivateKeyProvider({ config: { chainConfig } });
@@ -378,12 +376,11 @@ const chainConfig = {
378376
blockExplorerUrl: "https://etherscan.io",
379377
ticker: "ETH",
380378
tickerName: "Ethereum",
381-
logo: "https://images.toruswallet.io/ethereum.svg"
379+
logo: "https://images.toruswallet.io/ethereum.svg",
382380
};
383381

384382
const privateKeyProvider = new EthereumPrivateKeyProvider({ config: { chainConfig } });
385383

386-
387384
const web3auth = new Web3AuthNoModal({
388385
clientId: "", // Web3Auth Client ID
389386
web3AuthNetwork: "saphhire_mainnet",

‎docs/auth-provider-setup/social-providers/apple.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Apple Social Login with Web3Auth
33
sidebar_label: Apple
44

5-
displayed_sidebar: docs
5+
displayed_sidebar: resources
66
description: "Apple Social Login with Web3Auth | Documentation - Web3Auth"
77
---
88

@@ -46,7 +46,7 @@ const chainConfig = {
4646
blockExplorerUrl: "https://etherscan.io",
4747
ticker: "ETH",
4848
tickerName: "Ethereum",
49-
logo: "https://images.toruswallet.io/ethereum.svg"
49+
logo: "https://images.toruswallet.io/ethereum.svg",
5050
};
5151

5252
const privateKeyProvider = new EthereumPrivateKeyProvider({ config: { chainConfig } });

‎docs/auth-provider-setup/social-providers/baidu.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Baidu Login with Web3Auth
33
sidebar_label: Baidu
4-
displayed_sidebar: docs
4+
displayed_sidebar: resources
55
description: "Baidu Login with Web3Auth | Documentation - Web3Auth"
66
---
77

@@ -45,12 +45,11 @@ const chainConfig = {
4545
blockExplorerUrl: "https://etherscan.io",
4646
ticker: "ETH",
4747
tickerName: "Ethereum",
48-
logo: "https://images.toruswallet.io/ethereum.svg"
48+
logo: "https://images.toruswallet.io/ethereum.svg",
4949
};
5050

5151
const privateKeyProvider = new EthereumPrivateKeyProvider({ config: { chainConfig } });
5252

53-
5453
const web3auth = new Web3AuthNoModal({
5554
clientId,
5655
web3AuthNetwork: "sapphire_mainnet",

0 commit comments

Comments
 (0)