From 24354ccd6acd4b8b11f5a972eec1abb9f56ffce6 Mon Sep 17 00:00:00 2001 From: Dan Albert Date: Wed, 22 Apr 2020 17:48:21 -0600 Subject: [PATCH] Clean up wallet URL paths (#9667) automerge --- .gitbook.yaml | 13 +++++++++++++ docs/src/SUMMARY.md | 16 ++++++++-------- docs/src/cli/README.md | 2 +- docs/src/cli/conventions.md | 4 ++-- docs/src/cli/transfer-tokens.md | 6 +++--- docs/src/clusters.md | 2 +- .../README.md | 0 .../ledger.md | 4 ++-- docs/src/paper-wallet/paper-wallet-usage.md | 2 +- docs/src/{wallet => wallet-guide}/README.md | 8 ++++---- .../app-wallets.md => wallet-guide/apps.md} | 0 .../cli-wallets.md => wallet-guide/cli.md} | 4 ++-- docs/src/{wallet => wallet-guide}/ledger-live.md | 6 +++--- docs/src/{wallet => wallet-guide}/support.md | 0 .../src/{wallet => wallet-guide}/trust-wallet.md | 2 +- 15 files changed, 41 insertions(+), 28 deletions(-) rename docs/src/{remote-wallet => hardware-wallets}/README.md (100%) rename docs/src/{remote-wallet => hardware-wallets}/ledger.md (95%) rename docs/src/{wallet => wallet-guide}/README.md (94%) rename docs/src/{wallet/app-wallets.md => wallet-guide/apps.md} (100%) rename docs/src/{wallet/cli-wallets.md => wallet-guide/cli.md} (97%) rename docs/src/{wallet => wallet-guide}/ledger-live.md (91%) rename docs/src/{wallet => wallet-guide}/support.md (100%) rename docs/src/{wallet => wallet-guide}/trust-wallet.md (98%) diff --git a/.gitbook.yaml b/.gitbook.yaml index 74d01c16c..4a9bcde4f 100644 --- a/.gitbook.yaml +++ b/.gitbook.yaml @@ -3,3 +3,16 @@ root: ./docs/src structure: readme: introduction.md summary: SUMMARY.md + +redirects: + wallet: ./wallet-guide/README.md + wallet/app-wallets: ./wallet-guide/apps.md + wallet/app-wallets/trust-wallet: ./wallet-guide/trust-wallet.md + wallet/app-wallets/ledger-live: ./wallet-guide/ledger-live.md + wallet/cli-wallets: ./wallet-guide/cli.md + wallet/cli-wallets/paper-wallet: ./paper-wallet/README.md + wallet/cli-wallets/paper-wallet/paper-wallet-usage: ./paper-wallet/paper-wallet-usage.md + wallet/cli-wallets/remote-wallet: ./hardware-wallets/README.md + wallet/cli-wallets/remote-wallet/ledger: ./hardware-wallets/ledger.md + wallet/cli-wallets/file-system-wallet: ./file-system-wallet/README.md + wallet/support: ./wallet-guide/support.md diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index 35b5b5479..d9d30ea47 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -1,17 +1,17 @@ # Table of contents * [Introduction](introduction.md) -* [Wallet Guide](wallet/README.md) - * [App Wallets](wallet/app-wallets.md) - * [Trust Wallet](wallet/trust-wallet.md) - * [Ledger Live](wallet/ledger-live.md) - * [Command-line Wallets](wallet/cli-wallets.md) +* [Wallet Guide](wallet-guide/README.md) + * [App Wallets](wallet-guide/apps.md) + * [Trust Wallet](wallet-guide/trust-wallet.md) + * [Ledger Live](wallet-guide/ledger-live.md) + * [Command-line Wallets](wallet-guide/cli.md) * [Paper Wallet](paper-wallet/README.md) * [Paper Wallet Usage](paper-wallet/paper-wallet-usage.md) - * [Hardware Wallets](remote-wallet/README.md) - * [Ledger Hardware Wallet](remote-wallet/ledger.md) + * [Hardware Wallets](hardware-wallets/README.md) + * [Ledger Hardware Wallet](hardware-wallets/ledger.md) * [File System Wallet](file-system-wallet/README.md) - * [Support / Troubleshooting](wallet/support.md) + * [Support / Troubleshooting](wallet-guide/support.md) * [Command Line Guide](cli/README.md) * [Install the Solana Command Line Tool Suite](cli/install-solana-cli-tools.md) * [Command Line Conventions](cli/conventions.md) diff --git a/docs/src/cli/README.md b/docs/src/cli/README.md index 2e5df61f6..8078cf97e 100644 --- a/docs/src/cli/README.md +++ b/docs/src/cli/README.md @@ -14,5 +14,5 @@ secure access to your Solana accounts. To get started using the Solana Command Line (CLI) tools: - [Install the Solana Tools](install-solana-cli-tools.md) - [Choose a Cluster](choose-a-cluster.md) - - [Create a Wallet](../wallet/cli-wallets.md) + - [Create a Wallet](../wallet-guide/cli.md) - [Check out our CLI conventions](conventions.md) diff --git a/docs/src/cli/conventions.md b/docs/src/cli/conventions.md index 9a31f850d..d101cbd82 100644 --- a/docs/src/cli/conventions.md +++ b/docs/src/cli/conventions.md @@ -29,7 +29,7 @@ the base58 encoding of your public key, such as Many commands using the CLI tools require a value for a ``. The value you should use for the keypair depend on what type of -[command line wallet you created](../wallet/cli-wallets.md). +[command line wallet you created](../wallet-guide/cli.md). For example, the way to display any wallet's address (also known as the keypair's pubkey), the CLI help document shows: @@ -66,7 +66,7 @@ solana-keygen pubkey /home/solana/my_wallet.json #### Hardware Wallet If you chose a hardware wallet, use your -[keypair URL](../remote-wallet/README.md#specify-a-hardware-wallet-key), +[keypair URL](../hardware-wallets/README.md#specify-a-hardware-wallet-key), such as `usb://ledger?key=0`. ```bash solana-keygen pubkey usb://ledger?key=0 diff --git a/docs/src/cli/transfer-tokens.md b/docs/src/cli/transfer-tokens.md index 9a763552d..4ad17f472 100644 --- a/docs/src/cli/transfer-tokens.md +++ b/docs/src/cli/transfer-tokens.md @@ -2,7 +2,7 @@ This page decribes how to receive and send SOL tokens using the command line tools with a command line wallet such as a [paper wallet](../paper-wallet/README.md), a [file system wallet](../file-system-wallet/README.md), or a -[hardware wallet](../remote-wallet/README.md). Before you begin, make sure +[hardware wallet](../hardware-wallets/README.md). Before you begin, make sure you have created a wallet and have access to its address (pubkey) and the signing keypair. Check out our [conventions for entering keypairs for different wallet types](../cli/conventions.md#keypair-conventions). @@ -58,7 +58,7 @@ pubkey: GKvqsuNcnwWqPzzuhLmGi4rzzh55FhJtGizkhHaEJqiV You can also create a second (or more) wallet of any type: [paper](../paper-wallet/paper-wallet-usage.md#creating-multiple-paper-wallet-addresses), [file system](../file-system-wallet/README.md#creating-multiple-file-system-wallet-addresses), -or [hardware](../remote-wallet/README.md#multiple-addresses-on-a-single-hardware-wallet). +or [hardware](../hardware-wallets/README.md#multiple-addresses-on-a-single-hardware-wallet). #### Transfer tokens from your first wallet to the second address @@ -131,7 +131,7 @@ To receive tokens, you will need an address for others to send tokens to. In Solana, the wallet address is the public key of a keypair. There are a variety of techniques for generating keypairs. The method you choose will depend on how you choose to store keypairs. Keypairs are stored in wallets. Before receiving -tokens, you will need to [create a wallet](../wallet/cli-wallets.md). +tokens, you will need to [create a wallet](../wallet-guide/cli.md). Once completed, you should have a public key for each keypair you generated. The public key is a long string of base58 characters. Its length varies from 32 to 44 characters. diff --git a/docs/src/clusters.md b/docs/src/clusters.md index 6b71d452a..b7ea91bcd 100644 --- a/docs/src/clusters.md +++ b/docs/src/clusters.md @@ -89,7 +89,7 @@ Currently smart contracts, rewards, and inflation are disabled. * If you have paid money to purchase/be issued tokens, such as through our CoinList auction, these tokens will be transferred on Mainnet Beta. * Note: If you are using a non-command-line wallet such as - [Trust Wallet](wallet/trust-wallet.md), + [Trust Wallet](wallet-guide/trust-wallet.md), the wallet will always be connecting to Mainnet Beta. * Gossip entrypoint for Mainnet Beta: `mainnet-beta.solana.com:8001` * RPC URL for Mainnet Beta: `https://api.mainnet-beta.solana.com` diff --git a/docs/src/remote-wallet/README.md b/docs/src/hardware-wallets/README.md similarity index 100% rename from docs/src/remote-wallet/README.md rename to docs/src/hardware-wallets/README.md diff --git a/docs/src/remote-wallet/ledger.md b/docs/src/hardware-wallets/ledger.md similarity index 95% rename from docs/src/remote-wallet/ledger.md rename to docs/src/hardware-wallets/ledger.md index 3b14a1ddd..7f1a9f541 100644 --- a/docs/src/remote-wallet/ledger.md +++ b/docs/src/hardware-wallets/ledger.md @@ -6,7 +6,7 @@ secure transaction signing. ## Before You Begin -- [Set up a Ledger Nano S with the Solana App](../wallet/ledger-live.md) +- [Set up a Ledger Nano S with the Solana App](../wallet-guide/ledger-live.md) - [Install the Solana command-line tools](../cli/install-solana-cli-tools.md) ## Use Ledger Device with Solana CLI @@ -87,4 +87,4 @@ To fix, check the following: ## Support -Check out our [Wallet Support Page](../wallet/support.md) for ways to get help. +Check out our [Wallet Support Page](../wallet-guide/support.md) for ways to get help. diff --git a/docs/src/paper-wallet/paper-wallet-usage.md b/docs/src/paper-wallet/paper-wallet-usage.md index 7b2de2e07..a8eb845f0 100644 --- a/docs/src/paper-wallet/paper-wallet-usage.md +++ b/docs/src/paper-wallet/paper-wallet-usage.md @@ -168,4 +168,4 @@ your own accounts for different purposes. ## Support -Check out our [Wallet Support Page](../wallet/support.md) for ways to get help. +Check out our [Wallet Support Page](../wallet-guide/support.md) for ways to get help. diff --git a/docs/src/wallet/README.md b/docs/src/wallet-guide/README.md similarity index 94% rename from docs/src/wallet/README.md rename to docs/src/wallet-guide/README.md index 1ee48c5fb..175c0c781 100644 --- a/docs/src/wallet/README.md +++ b/docs/src/wallet-guide/README.md @@ -48,14 +48,14 @@ Solana supports supports several types of wallets in the Solana native command-line app as well as wallets from third-parties. For the majority of users, we recommend using one of the -[app wallets](app-wallets.md), which will provide a more familiar user +[app wallets](apps.md), which will provide a more familiar user experience rather than needing to learn command line tools. -{% page-ref page="app-wallets.md" %} +{% page-ref page="apps.md" %} -For advanced users or developers, the [command-line wallets](cli-wallets.md) +For advanced users or developers, the [command-line wallets](cli.md) may be more appropriate, as new features on the Solana blockchain will always be supported on the command line first before being integrated into third-party solutions. -{% page-ref page="cli-wallets.md" %} \ No newline at end of file +{% page-ref page="cli.md" %} \ No newline at end of file diff --git a/docs/src/wallet/app-wallets.md b/docs/src/wallet-guide/apps.md similarity index 100% rename from docs/src/wallet/app-wallets.md rename to docs/src/wallet-guide/apps.md diff --git a/docs/src/wallet/cli-wallets.md b/docs/src/wallet-guide/cli.md similarity index 97% rename from docs/src/wallet/cli-wallets.md rename to docs/src/wallet-guide/cli.md index 5d5eb6737..70af7c642 100644 --- a/docs/src/wallet/cli-wallets.md +++ b/docs/src/wallet-guide/cli.md @@ -5,7 +5,7 @@ directly with the Solana command-line tools. **If you are unfamiliar with using command line programs and just want to be able to send and receive SOL tokens, we recommend setting up a third-party -[App Wallet](app-wallets.md)**. +[App Wallet](apps.md)**. To use a Command Line Wallet, you must first [install the Solana CLI tools](../cli/install-solana-cli-tools.md) @@ -62,4 +62,4 @@ security and convenience for cryptocurrencies. It effectively automates the process of offline signing while retaining nearly all the convenience of an FS wallet. -{% page-ref page="../remote-wallet/README.md" %} +{% page-ref page="../hardware-wallet/README.md" %} diff --git a/docs/src/wallet/ledger-live.md b/docs/src/wallet-guide/ledger-live.md similarity index 91% rename from docs/src/wallet/ledger-live.md rename to docs/src/wallet-guide/ledger-live.md index 181c01ebc..c7753e281 100644 --- a/docs/src/wallet/ledger-live.md +++ b/docs/src/wallet-guide/ledger-live.md @@ -10,7 +10,7 @@ Integration with Ledger Live to use Solana wallet accounts on Ledger Live will be available in the future.** Users may [use a Ledger Nano S with the Solana command -line tools](../remote-wallet/ledger.md). +line tools](../hardware-wallets/ledger.md). ## Set up a Ledger Nano S - Order a [Nano S from Ledger](https://shop.ledger.com/products/ledger-nano-s) @@ -45,8 +45,8 @@ line tools](../remote-wallet/ledger.md). ## Interact with Solana network - To interact with your Ledger wallet on our live network, please see our instructions on how to -[use a Ledger Nano S with the Solana command line tools](../remote-wallet/ledger.md). +[use a Ledger Nano S with the Solana command line tools](../hardware-wallets/ledger.md). ## Support -Check out our [Wallet Support Page](../wallet/support.md) for ways to get help. +Check out our [Wallet Support Page](support.md) for ways to get help. diff --git a/docs/src/wallet/support.md b/docs/src/wallet-guide/support.md similarity index 100% rename from docs/src/wallet/support.md rename to docs/src/wallet-guide/support.md diff --git a/docs/src/wallet/trust-wallet.md b/docs/src/wallet-guide/trust-wallet.md similarity index 98% rename from docs/src/wallet/trust-wallet.md rename to docs/src/wallet-guide/trust-wallet.md index fc42494be..5d8e466bd 100644 --- a/docs/src/wallet/trust-wallet.md +++ b/docs/src/wallet-guide/trust-wallet.md @@ -104,4 +104,4 @@ If you are having trouble setting up your Trust Wallet app, check out their ## Support -Check out our [Wallet Support Page](../wallet/support.md) for ways to get help. +Check out our [Wallet Support Page](support.md) for ways to get help.