Skip to content

Commit

Permalink
Merge pull request #519 from Web3Auth/DR-182
Browse files Browse the repository at this point in the history
DR-182 - Update SDKs Reference
  • Loading branch information
shahbaz17 authored Oct 24, 2023
2 parents 9a9a41f + 4aa1b8c commit c10d52b
Show file tree
Hide file tree
Showing 20 changed files with 789 additions and 730 deletions.
4 changes: 2 additions & 2 deletions docs/dashboard-setup/dashboard-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: "Dashboard Setup | Documentation - Web3Auth"
---

import DashboardLoginPage from "@site/static/images/dashboard/dashboard.png";
import DashboardArchieve from "@site/static/images/dashboard/dashboard-archieve.png";
import DashboardArchive from "@site/static/images/dashboard/dashboard-archive.png";
import DashboardBilling from "@site/static/images/dashboard/dashboard-billings-home.png";
import DashboardBillingPayment from "@site/static/images/dashboard/dashboard-billings-payment.png";
import DashboardBillingPlans from "@site/static/images/dashboard/dashboard-billings-plans.png";
Expand Down Expand Up @@ -118,7 +118,7 @@ created.
Welcome to the Archive section of your dashboard. Here, you can easily access all of your archived projects.

<div style={{ flexBasis: "300px", flexGrow: "1", textAlign: "center" }}>
<img src={DashboardArchieve} style={{ alignSelf: "center", maxWidth: "100%" }} alt="Dashboard Plug n Play Projects" />
<img src={DashboardArchive} style={{ alignSelf: "center", maxWidth: "100%" }} alt="Dashboard Plug n Play Projects" />
</div>

## Settings
Expand Down
4 changes: 2 additions & 2 deletions docs/dashboard-setup/projects-and-analytics.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -91,10 +91,10 @@ Remember to whitelist all relevant URLs to guarantee seamless integration with W
<img src={DashboardWhiteListURL} style={{ alignSelf: "center", maxWidth: "100%" }} alt="Dashboard Whitelist" />
</div>

### Archieve a project
### Archive a project

You can archive a project by clicking the "Archive" button on the project page. This action will remove the project from the dashboard and prevent you
from using the Client ID to authenticate users. You can unarchive a project by clicking the "Unarchive" button from the archieve page .
from using the Client ID to authenticate users. You can unarchive a project by clicking the "Unarchive" button from the archive page.

## Project Analytics

Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/core-kit/sfa-android/sfa-android.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ However, if you want more control over the UI and UX of the authentication proce
This is possible with the new Web3Auth SFA Android SDK, which allows you to use Web3Auth SFA Android and prevent redirection to openlogin hosted
screens.

#### This Documentation is based on `0.0.4` SDK Version.
#### This Documentation is based on the `0.0.6` SDK Version.

## Requirements

Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/core-kit/sfa-flutter/sfa-flutter.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ However, if you want more control over the UI and UX of the authentication proce
This is possible with the new Web3Auth SFA Flutter SDK, which allows you to use Web3Auth SFA Flutter and prevent redirection to openlogin hosted
screens.

#### This Documentation is based on `1.0.0` SDK Version.
#### This Documentation is based on the `1.0.0` SDK Version.

## Requirements

Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/core-kit/sfa-ios/sfa-ios.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Web3Auth Plug and Play iOS SDK to redirect users to a Web3Auth-hosted screen (`h
However, if you want more control over the UI and UX of the authentication process, you can customize the authentication flow to avoid redirection.
This is possible with the new Web3Auth SFA iOS SDK, which allows you to use Web3Auth SFA iOS and prevent redirection to openlogin hosted screens.

#### This Documentation is based on `2.0.3` SDK Version.
#### This Documentation is based on the `2.0.3` SDK Version.

### Requirements

Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/core-kit/sfa-node/sfa-node.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Hence we can call this flow a semi-custodial flow, and encourage users to enable

:::

#### This Documentation is based on `3.0.0` SDK Version.
#### This Documentation is based on the `3.1.0` SDK Version.

## Requirements

Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/core-kit/sfa-react-native/sfa-react-native.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ SFA React Native and circumvent redirection to openlogin hosted screens.
This SDK offers you the flexibility to provide seamless and secure authentication for your users while preserving your app's unique user experience
and interface.

#### This Documentation is based on `2.0.0` SDK Version.
#### This Documentation is based on the `2.0.0` SDK Version.

## Requirements

Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/pnp/android/android.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ authenticate users using Web3Auth. For using Web3Auth natively in Android, Web3A
key generated in a non-custodial way on successful user authentication. This authentication can be achieved by using any social login options that
Web3Auth supports or using a custom authentication flow of your choice.

#### This Documentation is based on `5.0.2` SDK Version.
#### This Documentation is based on the `5.0.2` SDK Version.

## Requirements

Expand Down
4 changes: 2 additions & 2 deletions docs/sdk/pnp/flutter/flutter.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Web3Auth provides a [Flutter SDK](https://github.com/Web3Auth/web3auth-flutter-s
Flutter app to authenticate users using Web3Auth. It returns a private key generated in a non-custodial way on successful user authentication. This
authentication is achieved by using any of the supported social logins Web3Auth provides or using a custom authentication flow of your choice.

#### This Documentation is based on `2.0.3` SDK Version.
#### This Documentation is based on the `2.0.3` SDK Version.

## Requirements

Expand All @@ -21,7 +21,7 @@ authentication is achieved by using any of the supported social logins Web3Auth
- [Quick Start](/quick-start?product=Plug+and+Play&sdk=Plug+and+Play+Flutter+SDK): Integrate Web3Auth in 4 Simple Steps.

- [Integration Builder](/integration-builder?lang=FLUTTER&chain=ETH&customAuth=NONE&mfa=DEFAULT&whitelabel=NO&web3AuthNetwork=TESTNET&evmFramework=WEB3&useModal=YES&rnMode=EXPO&stepIndex=0&stepIndex=0):
Get customised integration code with detailed reference for your specific use case.
Get customized integration code with detailed references for your specific use case.

- [Example Applications](/examples?product=Plug+and+Play&sdk=Plug+and+Play+Flutter+SDK): Explore our example applications and try the SDK yourself.

Expand Down
6 changes: 3 additions & 3 deletions docs/sdk/pnp/ios/ios.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Web3Auth PnP iOS SDK
title: Web3Auth PnP iOS/Swift SDK
image: "images/docs-meta-cards/sdk-reference-card.png"
displayed_sidebar: sdk
description: "Web3Auth PnP iOS SDK | Documentation - Web3Auth"
Expand All @@ -10,7 +10,7 @@ iOS SDK is a client-side library you can use with your iOS app to authenticate u
custodial way on successful authentication of the user. This authentication can be achieved by using any of the social logins Web3Auth provides or
using a custom authentication flow of your choice.

#### This Documentation is based on `6.0.1` SDK Version.
#### This Documentation is based on the `6.0.1` SDK Version.

### Requirements

Expand All @@ -31,4 +31,4 @@ using a custom authentication flow of your choice.

- [Source Code](https://github.com/Web3Auth/web3auth-swift-sdk): Web3Auth is open sourced. You can find the source code on our GitHub repository.

- [Community Portal](https://web3auth.io/community): Join our community to get support from our team and other developers.
- [Community Portal](https://web3auth.io/community/c/help-pnp/pnp-ios/17): Join our community to get support from our team and other developers.
2 changes: 1 addition & 1 deletion docs/sdk/pnp/react-native/react-native.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ TypeScript. The Web3Auth React Native SDK is a client-side library you can use w
returns a private key generated in a non-custodial way on successful authentication of the user. This authentication can be achieved by using any of
the social logins Web3Auth provides or using a custom authentication flow of your choice.

#### This Documentation is based on `5.0.0` SDK Version.
#### This Documentation is based on the `5.0.0` SDK Version.

### Requirements

Expand Down
8 changes: 4 additions & 4 deletions docs/sdk/pnp/unity/unity.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ description: "Web3Auth PnP Unity SDK | Documentation - Web3Auth"
image: "images/docs-meta-cards/sdk-reference-card.png"
---

The Web3Auth [Unity SDK](https://github.com/Web3Auth/web3auth-unity-sdk) is a client-side library which allows you to authenticate users using
Web3Auth on `Unity3D` game engine. This SDK has been written majorly in `C#` and can be integrated preferably across all mobile platforms. It returns
a private key generated in a non-custodial way on successful user authentication. This authentication can be achieved by using any social login
options that Web3Auth supports or using a custom authentication flow of your choice.
The Web3Auth [Unity SDK](https://github.com/Web3Auth/web3auth-unity-sdk) is a client-side library that allows you to authenticate users using Web3Auth
on `Unity3D` game engine. This SDK has been written majorly in `C#` and can be integrated preferably across all mobile platforms. It returns a private
key generated in a non-custodial way on successful user authentication. This authentication can be achieved by using any social login options that
Web3Auth supports or uses a custom authentication flow of your choice.

#### This Documentation is based on the `2.0.0` SDK Version.

Expand Down
10 changes: 5 additions & 5 deletions docs/sdk/pnp/unreal/unreal.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ description: "Web3Auth PnP Unreal Engine SDK | Documentation - Web3Auth"
image: "images/docs-meta-cards/sdk-reference-card.png"
---

The Web3Auth [Unreal Engine SDK](https://github.com/Web3Auth/web3auth-unreal-sdk) is a client-side library which allows you to authenticate users
using Web3Auth on `Unreal` game engine. This SDK has been written majorly in `C++` and can be integrated preferably across all mobile platforms. It
returns a private key generated in a non-custodial way on successful user authentication. This authentication can be achieved by using any social
login options that Web3Auth supports or using a custom authentication flow of your choice.
The Web3Auth [Unreal Engine SDK](https://github.com/Web3Auth/web3auth-unreal-sdk) is a client-side library that allows you to authenticate users using
Web3Auth on `Unreal` game engine. This SDK has been written mainly in `C++` and can be integrated preferably across all mobile platforms. It returns a
private key generated in a non-custodial way on successful user authentication. This authentication can be achieved by using any social login options
that Web3Auth supports or using a custom authentication flow of your choice.

#### This Documentation is based on `1.0` SDK Version.
#### This Documentation is based on the `1.0` SDK Version.

### Requirements

Expand Down
4 changes: 2 additions & 2 deletions docs/sdk/pnp/web/modal/modal.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This package provides the main class for using the default Web3Auth Modal. The p
implementing Web3Auth within your interface. Additionally, it is a child class of [`@web3auth/no-modal`](/sdk/pnp/web/no-modal) package. Hence, you
can still call all the functions available in the [`@web3auth/no-modal`](/sdk/pnp/web/no-modal) package.

#### This Documentation is based on `7.0.0` SDK Version.
#### This Documentation is based on the `7.0.5` SDK Version.

## Requirements

Expand All @@ -29,4 +29,4 @@ can still call all the functions available in the [`@web3auth/no-modal`](/sdk/pn

- [Source Code](https://github.com/Web3Auth/web3auth-web/): Web3Auth is open sourced. You can find the source code on our GitHub repository.

- [Community Portal](https://web3auth.io/community): Join our community to get support from our team and other developers.
- [Community Portal](https://web3auth.io/community/c/help-pnp/pnp-modal/7): Join our community to get support from our team and other developers.
4 changes: 2 additions & 2 deletions docs/sdk/pnp/web/no-modal/no-modal.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Web3Auth Plug and Play No Modal is the main SDK that consists of the core module
for implementing the Web3Auth features, giving you the flexibility of implementing your own UI to use all the functionalities. Since this package
doesn't contain the UI Modal as compared to [`@web3auth/modal`](/sdk/pnp/web/modal) package, the size of this package is smaller.

#### This Documentation is based on `7.0.0` SDK Version.
#### This Documentation is based on the `7.0.4` SDK Version.

## Requirements

Expand All @@ -30,4 +30,4 @@ doesn't contain the UI Modal as compared to [`@web3auth/modal`](/sdk/pnp/web/mod

- [Source Code](https://github.com/Web3Auth/web3auth-web/): Web3Auth is open sourced. You can find the source code on our GitHub repository.

- [Community Portal](https://web3auth.io/community): Join our community to get support from our team and other developers.
- [Community Portal](https://web3auth.io/community/c/help-pnp/pnp-no-modal/15): Join our community to get support from our team and other developers.
2 changes: 2 additions & 0 deletions docs/sdk/pnp/web/wagmi-connector.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ connector for the popular [wagmi](https://github.com/tmm/wagmi) library to help
This package can be used to initialize a [wagmi client](https://wagmi.sh/docs/client) that will seamlessly manage the interaction(wallet connection
state and configuration, such as: auto-connection, connectors, and ethers providers) of your dApp with Web3Auth.

#### This Documentation is based on the `5.0.1` SDK Version.

:::tip DEMO

Checkout the [example apps](https://github.com/Web3Auth/web3auth-pnp-examples/tree/main/wagmi-connector) to see how wagmi works with Web3Auth.
Expand Down
Loading

1 comment on commit c10d52b

@vercel
Copy link

@vercel vercel bot commented on c10d52b Oct 24, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

web3auth-docs – ./

w3a-docs.vercel.app
web3auth-docs-git-master-web3auth.vercel.app
web3auth-docs-web3auth.vercel.app

Please sign in to comment.