From e63c181dd62a5b326930f727f6971501aee8ff15 Mon Sep 17 00:00:00 2001 From: Pawel-Szydlo <89639506+Pawel-Szydlo@users.noreply.github.com> Date: Tue, 26 Sep 2023 13:51:23 +0200 Subject: [PATCH] add metatags to docs (#65) * add metatags to docs * add changes from Kamil --- sdk/apps/docs/docs/application/connect.md | 2 +- .../docs/docs/application/sign_transaction.md | 2 +- sdk/apps/docs/docs/client/connect.md | 2 +- sdk/apps/docs/docs/client/sign.md | 2 +- sdk/apps/docs/docs/client/signMessage.md | 4 +- sdk/apps/docs/docs/home.md | 30 +++++++++------ sdk/apps/docs/docusaurus.config.js | 5 +++ sdk/apps/docs/src/pages/index.tsx | 38 ++++++++++++++++++- 8 files changed, 67 insertions(+), 18 deletions(-) diff --git a/sdk/apps/docs/docs/application/connect.md b/sdk/apps/docs/docs/application/connect.md index 6328bd4e..856fad5f 100644 --- a/sdk/apps/docs/docs/application/connect.md +++ b/sdk/apps/docs/docs/application/connect.md @@ -147,7 +147,7 @@ export default dynamic(() => Promise.resolve(SuiProvider), { ``` - + You can find example usage of this addapter here: https://github.com/nightly-labs/connect/blob/main/sdk/apps/modal-example/src/routes/aleph.tsx diff --git a/sdk/apps/docs/docs/application/sign_transaction.md b/sdk/apps/docs/docs/application/sign_transaction.md index 59c9927b..9dea9007 100644 --- a/sdk/apps/docs/docs/application/sign_transaction.md +++ b/sdk/apps/docs/docs/application/sign_transaction.md @@ -57,7 +57,7 @@ const signedTx: SignedTransaction = await app.signTransactionBlock({ ``` - + Nightly connect automatically turns into remote signer after connection from client (Mobile/Extension). Signing transaction is as simple as passing `signer` object diff --git a/sdk/apps/docs/docs/client/connect.md b/sdk/apps/docs/docs/client/connect.md index b418b6a7..80153431 100644 --- a/sdk/apps/docs/docs/client/connect.md +++ b/sdk/apps/docs/docs/client/connect.md @@ -88,7 +88,7 @@ await client.connect(message) ``` - + ```js import { ClientPolkadot } from '@nightlylabs/nightly-connect-polkadot' diff --git a/sdk/apps/docs/docs/client/sign.md b/sdk/apps/docs/docs/client/sign.md index 4579141e..6dc185c1 100644 --- a/sdk/apps/docs/docs/client/sign.md +++ b/sdk/apps/docs/docs/client/sign.md @@ -90,7 +90,7 @@ client.on('signTransactions', async (e) => { ``` - + ```js diff --git a/sdk/apps/docs/docs/client/signMessage.md b/sdk/apps/docs/docs/client/signMessage.md index 10b4dcc5..69058e15 100644 --- a/sdk/apps/docs/docs/client/signMessage.md +++ b/sdk/apps/docs/docs/client/signMessage.md @@ -64,7 +64,7 @@ client.on('signMessages', async (e) => { ``` - -Signing messages on Polkadot works the same way as signing transactions + +Signing messages on Substrate works the same way as signing transactions diff --git a/sdk/apps/docs/docs/home.md b/sdk/apps/docs/docs/home.md index 7a88e78a..fc93cd6f 100644 --- a/sdk/apps/docs/docs/home.md +++ b/sdk/apps/docs/docs/home.md @@ -6,22 +6,15 @@ slug: / import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; - - - - - - - - ![Welcome to Nightly](../static/img/connect_landing_narrow.png) ### Nightly created to Connect -**Nightly Connect** is an easy and user friendly way to connect applications with client's wallet. Scan, connect and approve. In these few steps the application is connected to the wallet. +**Nightly Connect** is a permissionless, open-source solution that serves as both a wallet adapter and a bridge wallet, enabling connections through QR codes or deep links. + +We built this tool to lighten dApp developers in continuously adding new wallets. Now, after implementing Nightly Connect once, all standard-compliant wallets will be added automatically without any action required from dApp. -Secure way to communicate between wallets and dapps. -Nightly Connect can be easily adapted on any blockchain. Right now we are supporting wallets on Sui and Solana. +Our goal is to be compatible with every mobile wallet. Unfortunately, this requires minimal changes on the wallet's side. But it's worth it - after implementing these changes, any mobile application will be able to connect to any dApp through Nightly Connect using QR codes or deep links, and will gain access to tools such as push notifications. ### Get started @@ -55,6 +48,21 @@ npm i @nightlylabs/wallet-selector-sui yarn add @nightlylabs/wallet-selector-sui ``` + + + + +Simply integrate Nightly Connect to your application or wallet with our [Nightly Polkadot Connect package](https://www.npmjs.com/package/@nightlylabs/wallet-selector-polkadot). + +```bash +# Using NPM +npm i @nightlylabs/wallet-selector-polkadot + +# Using Yarn +yarn add @nightlylabs/wallet-selector-polkadot + +``` + diff --git a/sdk/apps/docs/docusaurus.config.js b/sdk/apps/docs/docusaurus.config.js index 67f73283..66ae8537 100644 --- a/sdk/apps/docs/docusaurus.config.js +++ b/sdk/apps/docs/docusaurus.config.js @@ -69,6 +69,11 @@ const config = { label: 'Client', position: 'left' }, + { + href: 'https://example.connect.nightly.app/', + label: 'Demo', + position: 'right' + }, { href: 'https://twitter.com/NightlyConnect', label: 'Twitter', diff --git a/sdk/apps/docs/src/pages/index.tsx b/sdk/apps/docs/src/pages/index.tsx index 044e7524..8f7b0c5c 100644 --- a/sdk/apps/docs/src/pages/index.tsx +++ b/sdk/apps/docs/src/pages/index.tsx @@ -2,5 +2,41 @@ import React from 'react' import { Redirect } from '@docusaurus/router' export default function Home(): JSX.Element { - return + return ( + <> + + + + + {/* */} + + + + {/* */} + {/* DublinCore */} + + + {/* */} + + {/* */} + + + + {/* */} + + + + ) }