torusresearch / torus-documentation

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

npm i

Local Development

npm run start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Build

npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.

torus-documentation's Issues

Using "passwordless" in loginConfig doesn't work

When trying to hide passwordless option in the torus wallet embed the following name must be used:

loginConfig: {
          'torus-auth0-email-passwordless': {
            name: 'Passwordless',
            typeOfLogin: 'passwordless',
            showOnDesktop: false,
            showOnMobile: false,
            showOnModal: false,
          }
        },

This is not reflected anywhere in the documentation, or in the js library, I had to look through GitHub issues to resolved this.

Routing issue

There’s something wrong with routing here (https://docs.tor.us/integration-builder/?b=wallet&lang=HTML&chain=Ethereum), try pressing the back button. It routes to 3 different routes before going to the correct page. please fix

Incorrect login function signature

OpenLogin#login return { privateKey: string } instead of string[]:

https://github.com/torusresearch/OpenLoginSdk/blob/c5ee94606cd94aa6c7d7e6ae43d1c05da586ef49/packages/core/types/src/OpenLogin.d.ts#L36-L38

https://docs.tor.us/open-login/api-reference/usage#login

"Edit this page" should not be shown to users on Web3auth and Torus documentation

Current:
Able to see a 'edit this page' button at the bottom of web3auth and torus docs

1. When I click on it in tor.us, it leads me to github (is this intended?)
2. When I click on it in web3auth, it leads me to error 404 page (is this intended?)

Expected:

• If users can edit docs by submitting a request on github, please fix point 2 above
• If users are not supposed to edit docs by submitting a request on github, please disable 'edit this page' function on both tor.us and web3auth documentation

update guide for custom verifier usage

add guide for aws cognitor x torus direct web sdk to demonstrate custom verifier

Outdated documentation on TorusSwiftDirectSDK using JWT

extraQueryParams is deprecated

torus-documentation/files/customauth/ios/ContentView.swift

Lines 180 to 187 in 01b8050

	let sub = SubVerifierDetails(loginType: .web,
	loginProvider: .jwt,
	clientId: "P7PJuBCXIHP41lcyty0NEb7Lgf7Zme8Q",
	verifierName: "torus-auth0-email-passwordless",
	redirectURL: "tdsdk://tdsdk/oauthCallback",
	extraQueryParams: ["verifier_id_field": "name"],
	jwtParams: ["domain":"torus-test.auth0.com"])

Commit:

• torusresearch/customauth-swift-sdk@5a72bee

link for comprehensive list is not valid

https://github.com/torusresearch/torus-documentation/blame/a11cda5d0bf92adecc36b2b0acad48080511a851/docs/customauth/what-is-customauth.mdx#L9

https://docs.tor.us/customauth/verifiers/supported-logins is not exist

caused by #63

const torus = new Torus(options);

link for Designing your key management architecture is not valid

https://github.com/torusresearch/torus-documentation/blame/2577011d07e1833badbfa4d347acb1f17fdeccd4/docs/customauth/integrating-customauth.mdx#L29

https://docs.tor.us/customauth/#designing-your-key-management-architecture is not exist

Bölüm 1

link for Compatibility and Common Patterns is not valid

https://github.com/torusresearch/torus-documentation/blame/a11cda5d0bf92adecc36b2b0acad48080511a851/docs/customauth/designing-your-key-management-architecture.mdx#L42

https://docs.tor.us/customauth/compatibility-and-common-patterns/

is not exist

OpenLogin installation via script

When I use script tag specified in the installation page, I end up with the error that Buffer is not defined
<script src="https://cdn.jsdelivr.net/npm/@toruslabs/openlogin@0"></script>

But this one works fine:
<script src="https://cdn.jsdelivr.net/npm/@toruslabs/openlogin"></script>

I have Google Chrome Version 90.0.4430.93 (Official Build) (x86_64), macos latest version