From 284920433f756797a672d7b014c1458b2c55edd3 Mon Sep 17 00:00:00 2001 From: Dan Albert Date: Thu, 26 Mar 2020 13:42:05 -0600 Subject: [PATCH] Restructure wallet docs to prep for app wallet content (#9088) automerge --- docs/src/SUMMARY.md | 16 +++++++++------- docs/src/cli/generate-keys.md | 4 ++-- .../install-solana-cli-tools.md} | 0 docs/src/cli/transfer-tokens.md | 2 +- docs/src/paper-wallet/usage.md | 2 +- docs/src/remote-wallet/ledger.md | 2 +- docs/src/running-validator/validator-reqs.md | 2 +- docs/src/wallet/README.md | 4 ++++ docs/src/wallet/app-wallets.md | 1 + .../choose-a-wallet.md => wallet/cli-wallets.md} | 16 +++++++++------- 10 files changed, 29 insertions(+), 20 deletions(-) rename docs/src/{install-solana.md => cli/install-solana-cli-tools.md} (100%) create mode 100644 docs/src/wallet/README.md create mode 100644 docs/src/wallet/app-wallets.md rename docs/src/{cli/choose-a-wallet.md => wallet/cli-wallets.md} (85%) diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index 599b4564c2..29a0dac501 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -1,13 +1,15 @@ # Table of contents * [Introduction](introduction.md) -* [Install the Solana Tool Suite](install-solana.md) -* [Command-line Guide](cli/README.md) - * [Choose a Wallet](cli/choose-a-wallet.md) - * [Hardware Wallets](remote-wallet/README.md) - * [Ledger Hardware Wallet](remote-wallet/ledger.md) - * [Paper Wallet](paper-wallet/README.md) - * [Paper Wallet Usage](paper-wallet/usage.md) +* [Wallet Guide](wallet/README.md) + * [App Wallets](wallet/app-wallets.md) + * [Command-line Wallets](wallet/cli-wallets.md) + * [Hardware Wallets](remote-wallet/README.md) + * [Ledger Hardware Wallet](remote-wallet/ledger.md) + * [Paper Wallet](paper-wallet/README.md) + * [Paper Wallet Usage](paper-wallet/usage.md) +* [Command Line Guide](cli/README.md) + * [Install the Solana Command Line Tool Suite](cli/install-solana-cli-tools.md) * [Generate Keys](cli/generate-keys.md) * [Send and Receive Tokens](cli/transfer-tokens.md) * [Delegate Stake](cli/delegate-stake.md) diff --git a/docs/src/cli/generate-keys.md b/docs/src/cli/generate-keys.md index fab39e6938..5e77ba19d5 100644 --- a/docs/src/cli/generate-keys.md +++ b/docs/src/cli/generate-keys.md @@ -4,8 +4,8 @@ In this section, we will generate a keypair, query it for its public key, and verify you control its private key. Before you begin, you will need to: -* [Install the Solana Tool Suite](../install-solana.md) -* [Choose a wallet](choose-a-wallet.md) +* [Install the Solana Tool Suite](install-solana-cli-tools.md) +* [Choose a wallet](cli-wallets.md) ## Generate an FS Wallet Keypair diff --git a/docs/src/install-solana.md b/docs/src/cli/install-solana-cli-tools.md similarity index 100% rename from docs/src/install-solana.md rename to docs/src/cli/install-solana-cli-tools.md diff --git a/docs/src/cli/transfer-tokens.md b/docs/src/cli/transfer-tokens.md index b307899978..9900a3e348 100644 --- a/docs/src/cli/transfer-tokens.md +++ b/docs/src/cli/transfer-tokens.md @@ -6,7 +6,7 @@ To receive tokens, you will need an address for others to send tokens to. In Solana, an 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 [choose a wallet](choose-a-wallet.md) and +tokens, you will need to [choose a wallet](cli-wallets.md) and [generate keys](generate-keys.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/paper-wallet/usage.md b/docs/src/paper-wallet/usage.md index c084ea622c..6803154b7f 100644 --- a/docs/src/paper-wallet/usage.md +++ b/docs/src/paper-wallet/usage.md @@ -12,7 +12,7 @@ protect against this scenario. ## Before You Begin -- [Install the Solana command-line tools](../install-solana.md) +- [Install the Solana command-line tools](../cli/install-solana-cli-tools.md) ### Check your installation diff --git a/docs/src/remote-wallet/ledger.md b/docs/src/remote-wallet/ledger.md index d7419df980..1321865b65 100644 --- a/docs/src/remote-wallet/ledger.md +++ b/docs/src/remote-wallet/ledger.md @@ -6,7 +6,7 @@ secure transaction signing. ## Before You Begin -- [Install the Solana command-line tools](../install-solana.md) +- [Install the Solana command-line tools](../cli/install-solana-cli-tools.md) - [Initialize your Ledger Nano S](https://support.ledger.com/hc/en-us/articles/360000613793) - [Install the latest device firmware](https://support.ledgerwallet.com/hc/en-us/articles/360002731113-Update-Ledger-Nano-S-firmware) - [Install Ledger Live](https://support.ledger.com/hc/en-us/articles/360006395553/) software on your computer diff --git a/docs/src/running-validator/validator-reqs.md b/docs/src/running-validator/validator-reqs.md index 6c50cd3df3..5dec07202d 100644 --- a/docs/src/running-validator/validator-reqs.md +++ b/docs/src/running-validator/validator-reqs.md @@ -33,7 +33,7 @@ Here are our recommendations for low, medium, and high end machine specification ## Software * We build and run on Ubuntu 18.04. Some users have had trouble when running on Ubuntu 16.04 -* See [Installing Solana](../install-solana.md) for the current Solana software release. +* See [Installing Solana](../cli/install-solana-cli-tools.md) for the current Solana software release. Be sure to ensure that the machine used is not behind a residential NAT to avoid NAT traversal issues. A cloud-hosted machine works best. **Ensure that IP ports 8000 through 10000 are not blocked for Internet inbound and outbound traffic.** diff --git a/docs/src/wallet/README.md b/docs/src/wallet/README.md new file mode 100644 index 0000000000..81bef4b603 --- /dev/null +++ b/docs/src/wallet/README.md @@ -0,0 +1,4 @@ +# Solana Wallet +This document describes the different wallet options that are available to users +of Solana who want to be able to send, receive and interact with +SOL tokens on the Solana blockchain. diff --git a/docs/src/wallet/app-wallets.md b/docs/src/wallet/app-wallets.md new file mode 100644 index 0000000000..c30346c167 --- /dev/null +++ b/docs/src/wallet/app-wallets.md @@ -0,0 +1 @@ +Documentation of supported for App Wallets coming soon! \ No newline at end of file diff --git a/docs/src/cli/choose-a-wallet.md b/docs/src/wallet/cli-wallets.md similarity index 85% rename from docs/src/cli/choose-a-wallet.md rename to docs/src/wallet/cli-wallets.md index 3d9e12fbc9..10986f894f 100644 --- a/docs/src/cli/choose-a-wallet.md +++ b/docs/src/wallet/cli-wallets.md @@ -1,11 +1,13 @@ -# Choose a Wallet +# Command Line Wallets -Keypairs are stored in *wallets* and wallets come in many forms. A wallet might -be a directory in your computer's file system, a piece of paper, or a -specialized device called a *hardware wallet*. Some wallets are easier to use -than others. Some are more secure than others. In this section, we will compare -and contrast different types of wallets and help you choose the wallet that -best fits your needs. +Solana supports several different types of wallets that can be used to interface +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 +[Web Wallet](app-wallets.md)**. + +To use a Command Line Wallet, you must first [install the Solana CLI tools](../cli/install-solana-cli-tools.md) ## File System Wallet