Skip to content

Commit b2b6b71

Browse files
Fix relative links errors for EW docs (#2557)
* Fix relative links errors * Convert links from absolute to relative. Signed-off-by: bgravenorst <[email protected]> * Fix broken external link causing CI failures. Signed-off-by: bgravenorst <[email protected]> --------- Signed-off-by: bgravenorst <[email protected]> Co-authored-by: Yashovardhan Agrawal <[email protected]> Co-authored-by: bgravenorst <[email protected]> Co-authored-by: Byron Gravenorst <[email protected]>
1 parent 4d74d6a commit b2b6b71

File tree

28 files changed

+342
-193
lines changed

28 files changed

+342
-193
lines changed

embedded-wallets/dashboard/whitelist.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -335,6 +335,6 @@ https://*.api.myapp.com
335335

336336
## Next steps
337337

338-
- **[Project Settings](../project-settings)** - Configure basic project information
339-
- **[Advanced Project Settings](../advanced/session-management)** - Access advanced configuration options
340-
- **[Session Management](../advanced/session-management)** - Control session duration and behavior
338+
- **[Project Settings](./project-settings.mdx)** - Configure basic project information
339+
- **[Advanced Project Settings](./advanced/session-management.mdx)** - Access advanced configuration options
340+
- **[Session Management](./advanced/session-management.mdx)** - Control session duration and behavior

embedded-wallets/sdk/_common/_advanced-config-options.mdx

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

embedded-wallets/sdk/android/README.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ dependencies {
5353

5454
:::info
5555

56-
Prerequisites Before you start, make sure you have registered on the [**Web3Auth Dashboard**](https://dashboard.web3auth.io/) and have set up your project. You can look into the [Dashboard Setup](/embedded-wallets/dashboard/) guide to learn more.
56+
Prerequisites Before you start, make sure you have registered on the [**Web3Auth Dashboard**](https://dashboard.web3auth.io/) and have set up your project. You can look into the [Dashboard Setup](../../dashboard/README.mdx) guide to learn more.
5757

5858
:::
5959

@@ -209,10 +209,10 @@ initializeCF.whenComplete { _, error ->
209209

210210
The Web3Auth Android SDK offers a rich set of advanced configuration options:
211211

212-
- **[Custom Authentication](./advanced/custom-authentication)**: Define authentication methods.
213-
- **[Whitelabeling & UI Customization](./advanced/whitelabel)**: Personalize the modal's appearance.
214-
- **[Multi-Factor Authentication (MFA)](./advanced/mfa)**: Set up and manage MFA.
215-
- **[DApp Share](./advanced/dapp-share)**: Share DApp sessions across devices.
212+
- **[Custom Authentication](./advanced/custom-authentication.mdx)**: Define authentication methods.
213+
- **[Whitelabeling & UI Customization](./advanced/whitelabel.mdx)**: Personalize the modal's appearance.
214+
- **[Multi-Factor Authentication (MFA)](./advanced/mfa.mdx)**: Set up and manage MFA.
215+
- **[DApp Share](./advanced/dapp-share.mdx)**: Share DApp sessions across devices.
216216

217217
:::tip
218218

embedded-wallets/sdk/android/advanced/README.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -115,15 +115,15 @@ var web3Auth = Web3Auth(
115115

116116
## Custom Authentication Methods
117117

118-
Control the login options presented to your users. For detailed configuration options and implementation examples, see the [Custom Authentication](./custom-authentication) section.
118+
Control the login options presented to your users. For detailed configuration options and implementation examples, see the [Custom Authentication](./custom-authentication.mdx) section.
119119

120120
## UI Customization
121121

122-
Create a seamless brand experience by customizing the Web3Auth Login Screens to match your application's design. For complete customization options, refer to the [Whitelabeling & UI Customization](./whitelabel) section.
122+
Create a seamless brand experience by customizing the Web3Auth Login Screens to match your application's design. For complete customization options, refer to the [Whitelabeling & UI Customization](./whitelabel.mdx) section.
123123

124124
## Multi-Factor Authentication (MFA)
125125

126-
Add additional security layers to protect user accounts with two-factor authentication. For detailed configuration options and implementation examples, see the [Multi-Factor Authentication](./mfa) section.
126+
Add additional security layers to protect user accounts with two-factor authentication. For detailed configuration options and implementation examples, see the [Multi-Factor Authentication](./mfa.mdx) section.
127127

128128
**Key Configuration Options:**
129129

embedded-wallets/sdk/flutter/README.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ flutter pub add web3auth_flutter
4242

4343
:::info
4444

45-
Prerequisites Before you start, make sure you have registered on the [**Web3Auth Dashboard**](https://dashboard.web3auth.io/) and have set up your project. You can look into the [Dashboard Setup](/embedded-wallets/dashboard/) guide to learn more.
45+
Prerequisites Before you start, make sure you have registered on the [**Web3Auth Dashboard**](https://dashboard.web3auth.io/) and have set up your project. You can look into the [Dashboard Setup](../../dashboard/README.mdx) guide to learn more.
4646

4747
:::
4848

@@ -239,10 +239,10 @@ If the API call to fetch the project configuration fails, the method will throw
239239

240240
The Web3Auth Flutter SDK offers a rich set of advanced configuration options:
241241

242-
- **[Custom Authentication](./advanced/custom-authentication)**: Define authentication methods.
243-
- **[Whitelabeling & UI Customization](./advanced/whitelabel)**: Personalize the modal's appearance.
244-
- **[Multi-Factor Authentication (MFA)](./advanced/mfa)**: Set up and manage MFA.
245-
- **[DApp Share](./advanced/dapp-share)**: Share DApp sessions across devices.
242+
- **[Custom Authentication](./advanced/custom-authentication.mdx)**: Define authentication methods.
243+
- **[Whitelabeling & UI Customization](./advanced/whitelabel.mdx)**: Personalize the modal's appearance.
244+
- **[Multi-Factor Authentication (MFA)](./advanced/mfa.mdx)**: Set up and manage MFA.
245+
- **[DApp Share](./advanced/dapp-share.mdx)**: Share DApp sessions across devices.
246246

247247
:::tip
248248

embedded-wallets/sdk/flutter/advanced/README.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -143,15 +143,15 @@ await Web3AuthFlutter.init(Web3AuthOptions(
143143

144144
## Custom Authentication Methods
145145

146-
Control the login options presented to your users. For detailed configuration options and implementation examples, see the [Custom Authentication](./custom-authentication) section.
146+
Control the login options presented to your users. For detailed configuration options and implementation examples, see the [Custom Authentication](./custom-authentication.mdx) section.
147147

148148
## UI Customization
149149

150-
Create a seamless brand experience by customizing the Web3Auth Login Screens to match your application's design. For complete customization options, refer to the [Whitelabeling & UI Customization](./whitelabel) section.
150+
Create a seamless brand experience by customizing the Web3Auth Login Screens to match your application's design. For complete customization options, refer to the [Whitelabeling & UI Customization](./whitelabel.mdx) section.
151151

152152
## Multi-Factor Authentication (MFA)
153153

154-
Add additional security layers to protect user accounts with two-factor authentication. For detailed configuration options and implementation examples, see the [Multi-Factor Authentication](./mfa) section.
154+
Add additional security layers to protect user accounts with two-factor authentication. For detailed configuration options and implementation examples, see the [Multi-Factor Authentication](./mfa.mdx) section.
155155

156156
**Key Configuration Options:**
157157

embedded-wallets/sdk/ios/README.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ pod 'Web3Auth', '~> 11.1.0'
5252

5353
:::info
5454

55-
Prerequisites Before you start, make sure you have registered on the [**Web3Auth Dashboard**](https://dashboard.web3auth.io/) and have set up your project. You can look into the [Dashboard Setup](/embedded-wallets/dashboard/) guide to learn more.
55+
Prerequisites Before you start, make sure you have registered on the [**Web3Auth Dashboard**](https://dashboard.web3auth.io/) and have set up your project. You can look into the [Dashboard Setup](../../dashboard/README.mdx) guide to learn more.
5656

5757
:::
5858

@@ -133,10 +133,10 @@ func application(_ app: UIApplication, open url: URL, options: [UIApplication.Op
133133

134134
The Web3Auth iOS SDK offers a rich set of advanced configuration options:
135135

136-
- **[Custom Authentication](./advanced/custom-authentication)**: Define authentication methods.
137-
- **[Whitelabeling & UI Customization](./advanced/whitelabel)**: Personalize the modal's appearance.
138-
- **[Multi-Factor Authentication (MFA)](./advanced/mfa)**: Set up and manage MFA.
139-
- **[DApp Share](./advanced/dapp-share)**: Share DApp sessions across devices.
136+
- **[Custom Authentication](./advanced/custom-authentication.mdx)**: Define authentication methods.
137+
- **[Whitelabeling & UI Customization](./advanced/whitelabel.mdx)**: Personalize the modal's appearance.
138+
- **[Multi-Factor Authentication (MFA)](./advanced/mfa.mdx)**: Set up and manage MFA.
139+
- **[DApp Share](./advanced/dapp-share.mdx)**: Share DApp sessions across devices.
140140

141141
:::tip
142142

embedded-wallets/sdk/ios/advanced/README.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -104,15 +104,15 @@ web3Auth = Web3Auth(W3AInitParams(
104104

105105
## Custom Authentication Methods
106106

107-
Control the login options presented to your users. For detailed configuration options and implementation examples, see the [Custom Authentication](./custom-authentication) section.
107+
Control the login options presented to your users. For detailed configuration options and implementation examples, see the [Custom Authentication](./custom-authentication.mdx) section.
108108

109109
## UI Customization
110110

111-
Create a seamless brand experience by customizing the Web3Auth Login Screens to match your application's design. For complete customization options, refer to the [Whitelabeling & UI Customization](./whitelabel) section.
111+
Create a seamless brand experience by customizing the Web3Auth Login Screens to match your application's design. For complete customization options, refer to the [Whitelabeling & UI Customization](./whitelabel.mdx) section.
112112

113113
## Multi-Factor Authentication (MFA)
114114

115-
Add additional security layers to protect user accounts with two-factor authentication. For detailed configuration options and implementation examples, see the [Multi-Factor Authentication](./mfa) section.
115+
Add additional security layers to protect user accounts with two-factor authentication. For detailed configuration options and implementation examples, see the [Multi-Factor Authentication](./mfa.mdx) section.
116116

117117
**Key Configuration Options:**
118118

embedded-wallets/sdk/js/README.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ npm install --save @web3auth/modal
3333

3434
:::info
3535

36-
Prerequisites Before you start, make sure you have registered on the [**Web3Auth Dashboard**](https://dashboard.web3auth.io/) and have set up your project. You can look into the [Dashboard Setup](/embedded-wallets/dashboard/) guide to learn more.
36+
Prerequisites Before you start, make sure you have registered on the [**Web3Auth Dashboard**](https://dashboard.web3auth.io/) and have set up your project. You can look into the [Dashboard Setup](../../dashboard/README.mdx) guide to learn more.
3737

3838
:::
3939

@@ -62,15 +62,15 @@ await web3auth.init()
6262

6363
The Web3Auth Modal SDK offers a rich set of advanced configuration options:
6464

65-
- **[Smart Accounts](./advanced/smart-accounts)**: Configure account abstraction parameters.
66-
- **[Custom Authentication](./advanced/custom-authentication)**: Define authentication methods.
67-
- **[Whitelabeling & UI Customization](./advanced/whitelabel)**: Personalize the modal's appearance.
68-
- **[Multi-Factor Authentication (MFA)](./advanced/mfa)**: Set up and manage MFA.
69-
- **[Wallet Services](./advanced/wallet-services)**: Integrate additional wallet services.
65+
- **[Smart Accounts](./advanced/smart-accounts.mdx)**: Configure account abstraction parameters.
66+
- **[Custom Authentication](./advanced/custom-authentication.mdx)**: Define authentication methods.
67+
- **[Whitelabeling & UI Customization](./advanced/whitelabel.mdx)**: Personalize the modal's appearance.
68+
- **[Multi-Factor Authentication (MFA)](./advanced/mfa.mdx)**: Set up and manage MFA.
69+
- **[Wallet Services](./advanced/wallet-services.mdx)**: Integrate additional wallet services.
7070

7171
:::tip
7272

73-
Head over to the [**Advanced Configuration**](./advanced) section to learn more about each configuration option.
73+
Head over to the [**Advanced Configuration**](./advanced/README.mdx) section to learn more about each configuration option.
7474

7575
:::
7676

embedded-wallets/sdk/js/advanced/README.mdx

Lines changed: 77 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ description: '@web3auth/modal Advanced Configuration | Embedded Wallets'
77
import TabItem from '@theme/TabItem'
88
import Tabs from '@theme/Tabs'
99
import Web3AuthOptions from '../../_common/_web3auth-options.mdx'
10-
import AdvancedConfigOptions from '../../_common/_advanced-config-options.mdx'
1110

1211
# Advanced Configuration
1312

@@ -52,4 +51,80 @@ export class AppComponent {
5251

5352
<Web3AuthOptions />
5453

55-
<AdvancedConfigOptions />
54+
## Session Management
55+
56+
Control how long users stay authenticated and how sessions persist.
57+
58+
**Key Configuration Options:**
59+
60+
- `sessionTime` - Session duration in seconds. Controls how long users remain authenticated before
61+
needing to log in again.
62+
- Minimum: 1 second (`1`).
63+
- Maximum: 30 days (`86400 * 30`).
64+
- Default: 7 days (`86400 * 7`).
65+
- `storageType` - Storage location for authentication state. Options:
66+
- `"local"`: Persists across browser tabs and browser restarts (localStorage)
67+
- `"session"`: Persists only in current tab, cleared when tab closes (sessionStorage)
68+
69+
```tsx
70+
const web3AuthOptions = {
71+
clientId: 'YOUR_WEB3AUTH_CLIENT_ID', // Pass your Web3Auth Client ID, ideally using an environment variable
72+
web3AuthNetwork: WEB3AUTH_NETWORK.SAPPHIRE_MAINNET,
73+
74+
// Session configuration
75+
sessionTime: 86400 * 7, // 7 days (in seconds)
76+
storageType: 'local', // 'local' (persistent across tabs) or 'session' (single tab only)
77+
}
78+
```
79+
80+
## Multi-Factor Authentication (MFA)
81+
82+
Add additional security layers to protect user accounts with two-factor authentication. For detailed
83+
configuration options and implementation examples, see the [Multi-Factor Authentication](./mfa.mdx)
84+
section.
85+
86+
**Key Configuration Options:**
87+
88+
- `mfaSettings` - Configure MFA settings for different authentication flows
89+
- `mfaLevel` - Control when users are prompted to set up MFA
90+
91+
## Custom Authentication Methods
92+
93+
Control the login options presented to your users and how they're displayed in the modal. For
94+
detailed configuration options and implementation examples, see the
95+
[Custom Authentication](./custom-authentication.mdx) section.
96+
97+
**Key Configuration Options:**
98+
99+
- `modalConfig` - Define which authentication methods are available and customize their appearance
100+
101+
## UI Customization
102+
103+
Create a seamless brand experience by customizing the Web3Auth Modal to match your application's
104+
design. For complete customization options, refer to the
105+
[Whitelabeling & UI Customization](./whitelabel.mdx) section.
106+
107+
**Key Configuration Options:**
108+
109+
- `uiConfig` - Personalize the modal's look and feel with custom colors, logos, themes, and more
110+
- `modalConfig` - Control the visibility and arrangement of authentication options
111+
112+
## Smart Accounts (Account Abstraction)
113+
114+
Improve user experience with gasless transactions and advanced account features. Learn more in the
115+
[Smart Accounts](./smart-accounts.mdx) documentation.
116+
117+
**Key Configuration Options:**
118+
119+
- `accountAbstractionConfig` - Fine-tune parameters for smart account implementation
120+
- `useAAWithExternalWallet` - Enable account abstraction functionality even when users connect with
121+
external wallets
122+
123+
## Wallet Services
124+
125+
Extend your application with enhanced wallet functionality. See the
126+
[Wallet Services](./wallet-services.mdx) documentation for complete configuration options.
127+
128+
**Key Configuration Options:**
129+
130+
- `walletServicesConfig` - Integrate additional wallet services and features

0 commit comments

Comments
 (0)