Skip to content

Commit

Permalink
remove ./ links
Browse files Browse the repository at this point in the history
  • Loading branch information
yashovardhan committed Sep 18, 2023
1 parent 0ff0604 commit 85712ef
Show file tree
Hide file tree
Showing 21 changed files with 61 additions and 54 deletions.
12 changes: 6 additions & 6 deletions docs/connect-blockchain/ethereum/ethereum.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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",
},
],
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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`).
Expand Down
6 changes: 3 additions & 3 deletions docs/pnp/features/whitelabel/whitelabel.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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)
4 changes: 2 additions & 2 deletions docs/product-fit/product-fit.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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/).

:::

Expand All @@ -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/).

:::

Expand Down
4 changes: 2 additions & 2 deletions docs/sdk/core-kit/mpc-core-kit/initialize.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
:::
Expand Down
3 changes: 2 additions & 1 deletion docs/sdk/core-kit/mpc-core-kit/install.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
6 changes: 3 additions & 3 deletions docs/sdk/core-kit/mpc-core-kit/usage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

:::

Expand Down Expand Up @@ -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.
:::
Expand Down
7 changes: 4 additions & 3 deletions docs/sdk/core-kit/tkey-android/usage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

:::
7 changes: 4 additions & 3 deletions docs/sdk/core-kit/tkey-ios/usage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

:::

Expand Down
6 changes: 4 additions & 2 deletions docs/sdk/core-kit/tkey/intrinsic-flow.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
16 changes: 8 additions & 8 deletions docs/sdk/core-kit/tkey/tkey.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
7 changes: 4 additions & 3 deletions docs/sdk/core-kit/tkey/usage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

:::

Expand Down
4 changes: 2 additions & 2 deletions docs/sdk/pnp/android/custom-authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

:::

Expand Down
4 changes: 2 additions & 2 deletions docs/sdk/pnp/flutter/custom-authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

:::

Expand Down
4 changes: 2 additions & 2 deletions docs/sdk/pnp/ios/custom-authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

:::

Expand Down
4 changes: 2 additions & 2 deletions docs/sdk/pnp/react-native/custom-authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

:::

Expand Down
4 changes: 2 additions & 2 deletions docs/sdk/pnp/unity/custom-authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

:::

Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/pnp/unreal/custom-authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
:::
2 changes: 1 addition & 1 deletion docs/sdk/pnp/web/adapters/wallet-connect-v1.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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).

:::

Expand Down
6 changes: 3 additions & 3 deletions docs/sdk/pnp/web/web.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

:::

Expand Down
3 changes: 2 additions & 1 deletion docs/troubleshooting/supported-browsers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

:::

0 comments on commit 85712ef

Please sign in to comment.