Merge pull request #151 from torusresearch/add-features-xrpl-sidebar

Add features section for ripple to the sidebar
torusresearch · Sep 4, 2023 · 878a8c1 · 878a8c1
2 parents a4bf428 + bf99b05
commit 878a8c1
Show file tree

Hide file tree

Showing 17 changed files with 139 additions and 0 deletions.
diff --git a/docs/xrpl-wallet/features/contacts.mdx b/docs/xrpl-wallet/features/contacts.mdx
@@ -0,0 +1,22 @@
+---
+title: Contacts
+---
+
+A user can add contacts to their wallet. This allows them to easily send
+payments to other users without having to remember their addresses.
+Contacts can be retrieved by going to the `Settings > Contacts` page.
+
+<div style={{textAlign: 'center'}}>
+
+![Contacts list](/contents/contacts-list.png)
+
+</div>
+
+To add a new address as a contact, click on the `Add Contact` button. This
+will open a modal where the user can enter the name and the XRPL address of the contact.
+
+<div style={{textAlign: 'center'}}>
+
+![Add a new contact](/contents/add-contact.png)
+
+</div>
diff --git a/docs/xrpl-wallet/features/export-private-key.mdx b/docs/xrpl-wallet/features/export-private-key.mdx
@@ -0,0 +1,16 @@
+---
+title: Private Key Export
+---
+
+If the user would like to export their private key and use their
+funds from a different wallet provider, they can export their private key from
+`Settings > Privacy & Security`.
+
+The soft copy of your Private key requires password protection. Please set a
+password to protect this file and keep a record of it offline.
+
+<div style={{textAlign: 'center'}}>
+
+![Export private key](/contents/export-privatekey-xrpl.png)
+
+</div>
diff --git a/docs/xrpl-wallet/features/import-account.mdx b/docs/xrpl-wallet/features/import-account.mdx
@@ -0,0 +1,14 @@
+---
+title: Importing an Account
+---
+
+If the user would like to import an existing account, they can do so by
+clicking on the `Import Account` button on the `Profile` page.
+
+A modal will appear with a form for the user to enter their secret key.
+
+<div style={{textAlign: 'center'}}>
+
+![Import Account](/contents/import-account-xrpl.png)
+
+</div>
diff --git a/docs/xrpl-wallet/features/list-of-features.mdx b/docs/xrpl-wallet/features/list-of-features.mdx
@@ -0,0 +1,14 @@
+---
+title: Features
+sidebar_label: List of Features
+---
+
+An overview of features of XRPL Wallet, to experience the wallet for yourself,
+head on to [xrpl.tor.us](https://xrpl.tor.us).
+
+- [Purchasing Cryptocurrency](purchase-cryptocurrency)
+- [Private Key Export](export-private-key)
+- [Themes](themes)
+- [NFTs](nfts)
+- [Import Account](import-account)
+- [Contacts](contacts)
diff --git a/docs/xrpl-wallet/features/nfts.mdx b/docs/xrpl-wallet/features/nfts.mdx
@@ -0,0 +1,13 @@
+---
+title: NFTs
+---
+
+If you own any NFTs, you can view them in the NFTs tab. You can also see the pending NFT
+offers received or sent.
+
+
+<div style={{textAlign: 'center'}}>
+
+![NFTs](/contents/nfts-xrpl.png)
+
+</div>
diff --git a/docs/xrpl-wallet/features/purchase-cryptocurrency.mdx b/docs/xrpl-wallet/features/purchase-cryptocurrency.mdx
@@ -0,0 +1,21 @@
+---
+title: Purchasing Cryptocurrency
+---
+
+Torus has a range of providers to allow your users to purchase cryptocurrencies
+directly with credit card/wire transfer. Developers can either access this
+by presenting the "Topup" page below or trigger the fiat-to-crypto
+providers directly from the API.
+
+It's worth noting that as the fiat-to-Crypto landscape is a complex and regulated
+industry, each provider comes with their pros and cons. Currently, we support Simplex and
+Topper as providers.
+
+<div style={{textAlign: 'center'}}>
+
+![Purchase XRP directly](/contents/purchasing-XRP.png)
+
+</div>
+
+Through these third-party providers, we currently support the direct purchase of
+XRP.
diff --git a/docs/xrpl-wallet/features/themes.mdx b/docs/xrpl-wallet/features/themes.mdx
@@ -0,0 +1,29 @@
+---
+title: Themes
+---
+
+We provide a dark and light theme for users to choose from. Customize the wallet
+theme as per your choice. You can click on the `Theme` button in the `Settings`
+section to change the theme.
+
+<div style={{textAlign: 'center'}}>
+
+![Choice of theme](/contents/themes-xrpl.png)
+
+</div>
+
+## Light Theme
+
+<div style={{textAlign: 'center'}}>
+
+![Light Theme](/contents/light-xrpl.png)
+
+</div>
+
+## Dark theme
+
+<div style={{textAlign: 'center'}}>
+
+![Dark Theme](/contents/dark-xrpl.png)
+
+</div>
diff --git a/sidebars.js b/sidebars.js
@@ -111,6 +111,16 @@ module.exports = {
             },
           ],
         },
+        {
+          Features: [
+            "xrpl-wallet/features/purchase-cryptocurrency",
+            "xrpl-wallet/features/export-private-key",
+            "xrpl-wallet/features/themes",
+            "xrpl-wallet/features/nfts",
+            "xrpl-wallet/features/contacts",
+            "xrpl-wallet/features/import-account",
+          ],
+        },
       ],
     },
     {

diff --git a/static/contents/add-contact.png b/static/contents/add-contact.png
diff --git a/static/contents/contacts-list.png b/static/contents/contacts-list.png
diff --git a/static/contents/dark-xrpl.png b/static/contents/dark-xrpl.png
diff --git a/static/contents/export-privatekey-xrpl.png b/static/contents/export-privatekey-xrpl.png
diff --git a/static/contents/import-account-xrpl.png b/static/contents/import-account-xrpl.png
diff --git a/static/contents/light-xrpl.png b/static/contents/light-xrpl.png
diff --git a/static/contents/nfts-xrpl.png b/static/contents/nfts-xrpl.png
diff --git a/static/contents/purchasing-XRP.png b/static/contents/purchasing-XRP.png
diff --git a/static/contents/themes-xrpl.png b/static/contents/themes-xrpl.png