From 85712eff21103e98ce3858cde604748d6406a547 Mon Sep 17 00:00:00 2001 From: Yashovardhan Agrawal Date: Mon, 18 Sep 2023 17:08:10 +0800 Subject: [PATCH] remove ./ links --- docs/connect-blockchain/ethereum/ethereum.mdx | 12 ++++++------ .../server-side-verification.mdx | 4 ++-- docs/pnp/features/whitelabel/whitelabel.mdx | 6 +++--- docs/product-fit/product-fit.mdx | 4 ++-- docs/sdk/core-kit/mpc-core-kit/initialize.mdx | 4 ++-- docs/sdk/core-kit/mpc-core-kit/install.mdx | 3 ++- docs/sdk/core-kit/mpc-core-kit/usage.mdx | 6 +++--- docs/sdk/core-kit/tkey-android/usage.mdx | 7 ++++--- docs/sdk/core-kit/tkey-ios/usage.mdx | 7 ++++--- docs/sdk/core-kit/tkey/intrinsic-flow.mdx | 6 ++++-- docs/sdk/core-kit/tkey/tkey.mdx | 16 ++++++++-------- docs/sdk/core-kit/tkey/usage.mdx | 7 ++++--- docs/sdk/pnp/android/custom-authentication.mdx | 4 ++-- docs/sdk/pnp/flutter/custom-authentication.mdx | 4 ++-- docs/sdk/pnp/ios/custom-authentication.mdx | 4 ++-- .../pnp/react-native/custom-authentication.mdx | 4 ++-- docs/sdk/pnp/unity/custom-authentication.mdx | 4 ++-- docs/sdk/pnp/unreal/custom-authentication.mdx | 2 +- docs/sdk/pnp/web/adapters/wallet-connect-v1.mdx | 2 +- docs/sdk/pnp/web/web.mdx | 6 +++--- docs/troubleshooting/supported-browsers.mdx | 3 ++- 21 files changed, 61 insertions(+), 54 deletions(-) diff --git a/docs/connect-blockchain/ethereum/ethereum.mdx b/docs/connect-blockchain/ethereum/ethereum.mdx index ec18cd11a..ea5305b0b 100644 --- a/docs/connect-blockchain/ethereum/ethereum.mdx +++ b/docs/connect-blockchain/ethereum/ethereum.mdx @@ -19,37 +19,37 @@ export const Ethereum = [ key: "web", title: "Web", icon: "logo-js.png", - path: "./web", + path: "/connect-blockchain/ethereum/web", }, { key: "android", title: "Android (Kotlin)", icon: "logo-android.png", - path: "./android", + path: "/connect-blockchain/ethereum/android", }, { key: "apple", title: "iOS (Swift)", icon: "logo-apple.png", - path: "./ios", + path: "/connect-blockchain/ethereum/ios", }, { key: "flutter", title: "Flutter", icon: "logo-flutter.png", - path: "./flutter", + path: "/connect-blockchain/ethereum/flutter", }, { key: "react-native", title: "React Native", icon: "logo-react.png", - path: "./react-native", + path: "/connect-blockchain/ethereum/react-native", }, { key: "unity", title: "Unity", icon: "logo-unity.png", - path: "./unity", + path: "/connect-blockchain/ethereum/unity", }, ], }, diff --git a/docs/pnp/features/server-side-verification/server-side-verification.mdx b/docs/pnp/features/server-side-verification/server-side-verification.mdx index 8fb9bf5d4..196b89bf9 100644 --- a/docs/pnp/features/server-side-verification/server-side-verification.mdx +++ b/docs/pnp/features/server-side-verification/server-side-verification.mdx @@ -10,8 +10,8 @@ import Tabs from "@theme/Tabs"; Currently Web3Auth supports two types of users :- -1. Users who login using [Social Logins or Email Passwordless](./social-login-users). -2. Users who login using [External Wallets](./external-wallets). +1. Users who login using [Social Logins or Email Passwordless](/pnp/features/server-side-verification/social-login-users). +2. Users who login using [External Wallets](/pnp/features/server-side-verification/external-wallets). As a dApp you might want to authenticate a Web3Auth user in your backend. Generally the authentication happens in Frontend, but for the backend authentication we will use a JWT Token(`idToken`). diff --git a/docs/pnp/features/whitelabel/whitelabel.mdx b/docs/pnp/features/whitelabel/whitelabel.mdx index 7b65b156c..e36c3e0c5 100644 --- a/docs/pnp/features/whitelabel/whitelabel.mdx +++ b/docs/pnp/features/whitelabel/whitelabel.mdx @@ -13,12 +13,12 @@ offerings. You can do whitelabelling across `Web3Auth Plug and Play Modal`, `User Flow Screens` via `Openlogin Adapter` and `Mobile SDKs`, and `Torus & Solana Wallet UI` instances. -- [Web3Auth Plug and Play Login Modal](./login-modal) +- [Web3Auth Plug and Play Login Modal](/pnp/features/whitelabel/login-modal) ![Web3Auth Plug and Play Login Modal](/images/whitelabel/modal/whitelable-login-modal.gif) -- [User Flow Screens](./user-flow-screens) +- [User Flow Screens](/pnp/features/whitelabel/user-flow-screens) ![Web3Auth - User Flow Screens](/images/whitelabel/user-flow-screens.gif) -- [Torus & Solana Wallet UI](./torus-wallet-plugin) +- [Torus & Solana Wallet UI](/pnp/features/whitelabel/torus-wallet-plugin) diff --git a/docs/product-fit/product-fit.mdx b/docs/product-fit/product-fit.mdx index dab8a3111..c1281a392 100644 --- a/docs/product-fit/product-fit.mdx +++ b/docs/product-fit/product-fit.mdx @@ -38,7 +38,7 @@ We've divided the questions into the following categories: :::tip - Read More about integrating [Web3Auth in Wallets](./web3auth-for-wallets/). + Read More about integrating [Web3Auth in Wallets](/product-fit/web3auth-for-wallets/). ::: @@ -48,7 +48,7 @@ We've divided the questions into the following categories: :::tip - Read More about integrating [Web3Auth in dApps](./web3auth-for-dapps/). + Read More about integrating [Web3Auth in dApps](/product-fit/web3auth-for-dapps/). ::: diff --git a/docs/sdk/core-kit/mpc-core-kit/initialize.mdx b/docs/sdk/core-kit/mpc-core-kit/initialize.mdx index 071d4cf34..f694a60bc 100644 --- a/docs/sdk/core-kit/mpc-core-kit/initialize.mdx +++ b/docs/sdk/core-kit/mpc-core-kit/initialize.mdx @@ -153,8 +153,8 @@ useEffect(() => { :::note -For the popup flow, the service worker is needed to handle it properly. Please have a look at the [installation page](./install) to know how to set up -the service worker for your application. +For the popup flow, the service worker is needed to handle it properly. Please have a look at the +[installation page](/sdk/core-kit/mpc-core-kit/install) to know how to set up the service worker for your application. ::: diff --git a/docs/sdk/core-kit/mpc-core-kit/install.mdx b/docs/sdk/core-kit/mpc-core-kit/install.mdx index 358461560..da4cc40af 100644 --- a/docs/sdk/core-kit/mpc-core-kit/install.mdx +++ b/docs/sdk/core-kit/mpc-core-kit/install.mdx @@ -47,7 +47,8 @@ where login was initiated. - Using service worker is required only in the popup flow. -- Service worker is needed if you are using `popup` uxMode within your [Service Provider configuration](./initialize#configuring-service-provider). +- Service worker is needed if you are using `popup` uxMode within your + [Service Provider configuration](/sdk/core-kit/mpc-core-kit/initialize#configuring-service-provider). - For browsers where service workers are not supported, or in the case you wish to not use service workers, create and serve redirect page (i.e `redirect.html` file). diff --git a/docs/sdk/core-kit/mpc-core-kit/usage.mdx b/docs/sdk/core-kit/mpc-core-kit/usage.mdx index 1015b8646..4bcdbe863 100644 --- a/docs/sdk/core-kit/mpc-core-kit/usage.mdx +++ b/docs/sdk/core-kit/mpc-core-kit/usage.mdx @@ -48,7 +48,7 @@ To login a user in the Web3Auth MPC Core Kit SDK, you need to call `connect()` f :::tip -Checkout the [Authentication Section](./authentication) to know more about the `loginParams` object. +Checkout the [Authentication Section](/sdk/core-kit/mpc-core-kit/authentication) to know more about the `loginParams` object. ::: @@ -120,8 +120,8 @@ useEffect(() => { :::note -For the popup flow, the service worker is needed to handle it properly. Please have a look at the [installation page](./install) to know how to set up -the service worker for your application. +For the popup flow, the service worker is needed to handle it properly. Please have a look at the +[installation page](/sdk/core-kit/mpc-core-kit/install) to know how to set up the service worker for your application. ::: diff --git a/docs/sdk/core-kit/tkey-android/usage.mdx b/docs/sdk/core-kit/tkey-android/usage.mdx index 56e7d449b..2e0214b91 100644 --- a/docs/sdk/core-kit/tkey-android/usage.mdx +++ b/docs/sdk/core-kit/tkey-android/usage.mdx @@ -267,11 +267,12 @@ activity.appKey.deleteShare(shareIndex, result -> {}); ## Using Modules for Further Operations To perform advanced operations and manipulate keys, tKey offers modules that can be utilized. As previously stated in the -[initialization](./initialize) section, modules need to be configured beforehand to function properly with tKey. After configuration, the respective -module's instance is accessible within your tKey instance and can be utilized for additional operations. +[initialization](/sdk/core-kit/tkey-android/initialize) section, modules need to be configured beforehand to function properly with tKey. After +configuration, the respective module's instance is accessible within your tKey instance and can be utilized for additional operations. :::info Modules -Please visit the [**Modules**](./modules) section to view a comprehensive list of available modules and their respective functions. +Please visit the [**Modules**](/sdk/core-kit/tkey-android/modules) section to view a comprehensive list of available modules and their respective +functions. ::: diff --git a/docs/sdk/core-kit/tkey-ios/usage.mdx b/docs/sdk/core-kit/tkey-ios/usage.mdx index e673bb187..c224526a2 100644 --- a/docs/sdk/core-kit/tkey-ios/usage.mdx +++ b/docs/sdk/core-kit/tkey-ios/usage.mdx @@ -570,12 +570,13 @@ let shareStore = try! await threshold_key.delete_share(share_index: idx) ## Using Modules for Further Operations To perform advanced operations and manipulate keys, tKey offers modules that can be utilized. As previously stated in the -[initialization](./initialize) section, modules need to be configured beforehand to function properly with tKey. After configuration, the respective -module's instance is accessible within your tKey instance and can be utilized for additional operations. +[initialization](/sdk/core-kit/tkey-ios/initialize) section, modules need to be configured beforehand to function properly with tKey. After +configuration, the respective module's instance is accessible within your tKey instance and can be utilized for additional operations. :::info Modules -Please visit the [**Modules**](./modules) section to view a comprehensive list of available modules and their respective functions. +Please visit the [**Modules**](/sdk/core-kit/tkey-ios/modules) section to view a comprehensive list of available modules and their respective +functions. ::: diff --git a/docs/sdk/core-kit/tkey/intrinsic-flow.mdx b/docs/sdk/core-kit/tkey/intrinsic-flow.mdx index ca5e7b72d..6b13c2163 100644 --- a/docs/sdk/core-kit/tkey/intrinsic-flow.mdx +++ b/docs/sdk/core-kit/tkey/intrinsic-flow.mdx @@ -141,9 +141,11 @@ where login was initiated. :::tip -- Using service worker is optional, but highly recommended. You can skip it by passing `skipSw` param while [initialising tKey](./initialize). +- Using service worker is optional, but highly recommended. You can skip it by passing `skipSw` param while + [initialising tKey](/sdk/core-kit/tkey/initialize). -- Service worker is needed if you are using `popup` uxMode within your [Service Provider configuration](./initialize#configuring-service-provider). +- Service worker is needed if you are using `popup` uxMode within your + [Service Provider configuration](/sdk/core-kit/tkey/initialize#configuring-service-provider). - For browsers where service workers are not supported, or in the case you wish to not use service workers, create and serve redirect page (i.e `redirect.html` file). diff --git a/docs/sdk/core-kit/tkey/tkey.mdx b/docs/sdk/core-kit/tkey/tkey.mdx index dfdec8926..7e6032dd1 100644 --- a/docs/sdk/core-kit/tkey/tkey.mdx +++ b/docs/sdk/core-kit/tkey/tkey.mdx @@ -42,17 +42,17 @@ The **Storage Layer** refers to the Metadata Storage, which is used to store the ### Modules -[**Modules**](./modules) are the various functionalities that can be added to the tKey SDK, tkey enhance the storage and usage of different shares -generated in a way it is most suitable for your project. +[**Modules**](/sdk/core-kit/tkey/modules) are the various functionalities that can be added to the tKey SDK, tkey enhance the storage and usage of +different shares generated in a way it is most suitable for your project. We have 3 types of modules available right now: -- [**Default Modules**](./modules/#default-modules): Modules needed for the basic operations of the tKey SDK. -- [**Storage Modules**](./modules/#storage-modules): Storage Modules are used to store the tKey shares in the user's device storage. -- [**Recovery Modules**](./modules/#recovery-modules): Recovery Modules are used to recover the tKey shares in the case user doesn't have access to - their device/storage or needs additional security. -- [**Additional Modules**](./modules/#additional-modules): These modules provide extra capability to the tKey SDK, like importing user's existing - private keys or seedphrases. +- [**Default Modules**](/sdk/core-kit/tkey/modules/#default-modules): Modules needed for the basic operations of the tKey SDK. +- [**Storage Modules**](/sdk/core-kit/tkey/modules/#storage-modules): Storage Modules are used to store the tKey shares in the user's device storage. +- [**Recovery Modules**](/sdk/core-kit/tkey/modules/#recovery-modules): Recovery Modules are used to recover the tKey shares in the case user doesn't + have access to their device/storage or needs additional security. +- [**Additional Modules**](/sdk/core-kit/tkey/modules/#additional-modules): These modules provide extra capability to the tKey SDK, like importing + user's existing private keys or seedphrases. ### Threshold diff --git a/docs/sdk/core-kit/tkey/usage.mdx b/docs/sdk/core-kit/tkey/usage.mdx index d189b9b4d..44c537b9c 100644 --- a/docs/sdk/core-kit/tkey/usage.mdx +++ b/docs/sdk/core-kit/tkey/usage.mdx @@ -190,12 +190,13 @@ console.log("Share has been deleted", shareStore); ## Using Modules For making advanced operations on tKey and to manipulate the keys, you can use the modules provided by tKey. As mentioned in the -[initialisation](./initialize) section, you need to configure the modules beforehand to make it work with tKey. Once that is done, the instance of the -respective module is available within your tKey instance and can be used for further operations. +[initialisation](/sdk/core-kit/tkey/initialize) section, you need to configure the modules beforehand to make it work with tKey. Once that is done, +the instance of the respective module is available within your tKey instance and can be used for further operations. :::tip -Checkout the [Modules](./modules) section where we have listed all the available modules alongside the functions that can be used within them. +Checkout the [Modules](/sdk/core-kit/tkey/modules) section where we have listed all the available modules alongside the functions that can be used +within them. ::: diff --git a/docs/sdk/pnp/android/custom-authentication.mdx b/docs/sdk/pnp/android/custom-authentication.mdx index 1dded088f..5bd7bdb28 100644 --- a/docs/sdk/pnp/android/custom-authentication.mdx +++ b/docs/sdk/pnp/android/custom-authentication.mdx @@ -25,8 +25,8 @@ Check out how to create a **[Custom Verifier](/auth-provider-setup/verifiers)** :::info using dapp share - dApp Share is only returned for the Custom verifiers. -- Also, 2FA should be enabled for the account using it. Use `mfaLevel = MFALevel.MANDATORY` in the `LoginParams` during login. See **[MFA](./mfa)** - for more details. +- Also, 2FA should be enabled for the account using it. Use `mfaLevel = MFALevel.MANDATORY` in the `LoginParams` during login. See + **[MFA](/sdk/pnp/android/custom-authentication/mfa)** for more details. ::: diff --git a/docs/sdk/pnp/flutter/custom-authentication.mdx b/docs/sdk/pnp/flutter/custom-authentication.mdx index d3eb6a5dc..49ec31dfc 100644 --- a/docs/sdk/pnp/flutter/custom-authentication.mdx +++ b/docs/sdk/pnp/flutter/custom-authentication.mdx @@ -25,8 +25,8 @@ Check out how to create a **[Custom Verifier](/auth-provider-setup/verifiers)** :::info using dapp share - dApp Share is only returned for the Custom verifiers. -- Also, 2FA should be enabled for the account using it. Use `mfaLevel = MFALevel.MANDATORY` in the `LoginParams` during login. See **[MFA](./mfa)** - for more details. +- Also, 2FA should be enabled for the account using it. Use `mfaLevel = MFALevel.MANDATORY` in the `LoginParams` during login. See + **[MFA](/sdk/pnp/flutter/custom-authentication/mfa)** for more details. ::: diff --git a/docs/sdk/pnp/ios/custom-authentication.mdx b/docs/sdk/pnp/ios/custom-authentication.mdx index 3000a91c0..af1d36f09 100644 --- a/docs/sdk/pnp/ios/custom-authentication.mdx +++ b/docs/sdk/pnp/ios/custom-authentication.mdx @@ -25,8 +25,8 @@ Check out how to create a **[Custom Verifier](/auth-provider-setup/verifiers)** :::info using dapp share - dApp Share is only returned for the Custom verifiers. -- Also, 2FA should be enabled for the account using it. Use `mfaLevel = MFALevel.MANDATORY` in the `W3ALoginParams` during login. See **[MFA](./mfa)** - for more details. +- Also, 2FA should be enabled for the account using it. Use `mfaLevel = MFALevel.MANDATORY` in the `W3ALoginParams` during login. See + **[MFA](/sdk/pnp/ios/custom-authentication/mfa)** for more details. ::: diff --git a/docs/sdk/pnp/react-native/custom-authentication.mdx b/docs/sdk/pnp/react-native/custom-authentication.mdx index 4e4c75888..a88500579 100644 --- a/docs/sdk/pnp/react-native/custom-authentication.mdx +++ b/docs/sdk/pnp/react-native/custom-authentication.mdx @@ -24,8 +24,8 @@ Check out how to create a **[Custom Verifier](/auth-provider-setup/verifiers)** :::info using dapp share - dApp Share is only returned for the Custom verifiers. -- Also, 2FA should be enabled for the account using it. Use `mfaLevel = MFALevel.MANDATORY` in the `LoginParams` during login. See **[MFA](./mfa)** - for more details. +- Also, 2FA should be enabled for the account using it. Use `mfaLevel = MFALevel.MANDATORY` in the `LoginParams` during login. See + **[MFA](/sdk/pnp/react-native/custom-authentication/mfa)** for more details. ::: diff --git a/docs/sdk/pnp/unity/custom-authentication.mdx b/docs/sdk/pnp/unity/custom-authentication.mdx index f2b767c18..8645f1173 100644 --- a/docs/sdk/pnp/unity/custom-authentication.mdx +++ b/docs/sdk/pnp/unity/custom-authentication.mdx @@ -200,8 +200,8 @@ void Start() :::note - dApp Share is only returned for the Custom Authentication verifiers. -- Also, 2FA should be enabled for the account using it. Use `mfaLevel = MFALevel.MANDATORY` in the `LoginParams` during login. See **[MFA](./mfa)** - for more details. +- Also, 2FA should be enabled for the account using it. Use `mfaLevel = MFALevel.MANDATORY` in the `LoginParams` during login. See + **[MFA](/sdk/pnp/unity/custom-authentication/mfa)** for more details. ::: diff --git a/docs/sdk/pnp/unreal/custom-authentication.mdx b/docs/sdk/pnp/unreal/custom-authentication.mdx index 2334a6177..64939f9a7 100644 --- a/docs/sdk/pnp/unreal/custom-authentication.mdx +++ b/docs/sdk/pnp/unreal/custom-authentication.mdx @@ -187,6 +187,6 @@ enum class FTypeOfLogin : uint8 - dApp Share is only returned for the Custom Authentication verifiers. - Also, 2FA should be enabled for the account using it. - Use `mfaLevel = MFALevel.MANDATORY` in the `LoginParams` during login. See **[MFA](./mfa)** for more details. + Use `mfaLevel = MFALevel.MANDATORY` in the `LoginParams` during login. See **[MFA](/sdk/pnp/unreal/custom-authentication/mfa)** for more details. ::: diff --git a/docs/sdk/pnp/web/adapters/wallet-connect-v1.mdx b/docs/sdk/pnp/web/adapters/wallet-connect-v1.mdx index c5cc1f3b4..7a717efa8 100644 --- a/docs/sdk/pnp/web/adapters/wallet-connect-v1.mdx +++ b/docs/sdk/pnp/web/adapters/wallet-connect-v1.mdx @@ -12,7 +12,7 @@ import Tabs from "@theme/Tabs"; :::danger deprecated -Wallet Connect V1 is going to be deprecated, please use [**Wallet Connect v2 Adapter**](./wallet-connect-v2). +Wallet Connect V1 is going to be deprecated, please use [**Wallet Connect v2 Adapter**](/sdk/pnp/web/adapters/wallet-connect-v2). ::: diff --git a/docs/sdk/pnp/web/web.mdx b/docs/sdk/pnp/web/web.mdx index ffcd5399b..b8a1230ea 100644 --- a/docs/sdk/pnp/web/web.mdx +++ b/docs/sdk/pnp/web/web.mdx @@ -77,12 +77,12 @@ Currently we have the following adapters available for utilisation: **wagmi** is a collection of React Hooks containing everything you need to start working with Ethereum. Web3Auth can be used with wagmi library to ease the integration process for a dApp using wagmi hooks. -Simply use [`@web3auth/web3auth-wagmi-connector`](./wagmi-connector) which connects with both Modal and No Modal SDKs in your dApp to manage the -interactions seamlessly. +Simply use [`@web3auth/web3auth-wagmi-connector`](/sdk/pnp/web/wagmi-connector) which connects with both Modal and No Modal SDKs in your dApp to +manage the interactions seamlessly. :::tip -Head on to the [`@web3auth/web3auth-wagmi-connector`](./wagmi-connector) to get started. +Head on to the [`@web3auth/web3auth-wagmi-connector`](/sdk/pnp/web/wagmi-connector) to get started. ::: diff --git a/docs/troubleshooting/supported-browsers.mdx b/docs/troubleshooting/supported-browsers.mdx index e2cdf2874..229f522cd 100644 --- a/docs/troubleshooting/supported-browsers.mdx +++ b/docs/troubleshooting/supported-browsers.mdx @@ -26,6 +26,7 @@ listed below. The versions are listed according to this [page](https://browsersl :::info source code -When creating your React App in production, make sure to follow the steps described [here](./react-big-int-error) to avoid BigInt Error. +When creating your React App in production, make sure to follow the steps described [here](/troubleshooting/react-big-int-error) to avoid BigInt +Error. :::