Merge pull request #846 from filecoin-project/@jimmylee/docs-update-2

documentation: updates from the testing session

documentation/en/api-troubleshooting.md

@@ -17,7 +17,7 @@ curl -X POST \
 
 ## Sending a CID
 
-If you do not serialize the CID as a JSON IPLD link, you will receive an error. Here is an example of a broken CURL request:
+If you do not serialize the CID as a [JSON IPLD link](https://did-ipid.github.io/ipid-did-method/#txref), you will receive an error. Here is an example of a broken CURL request:
 
 ```sh
 curl -X POST \

documentation/en/api.md

@@ -6,7 +6,7 @@ Implementation details for the **JSON-RPC** package are [here](https://github.co
 
 ## Overview
 
-API requests are made against `127.0.0.1:1234` unless you modify `~/.lotus/api`. 
+API requests are made against `127.0.0.1:1234` unless you modify `.lotus/config.toml`. 
 
 Options:
 
@@ -16,7 +16,11 @@ Options:
 
 ## What methods can I use?
 
-Every `method` is available in [api/api.go](https://github.com/filecoin-project/lotus/blob/master/api/api_full.go). 
+For now, you can look into different files to find methods available to you based on your needs:
+
+* [Both Lotus node + storage miner APIs](https://github.com/filecoin-project/lotus/blob/master/api/api_common.go)
+* [Lotus node API](https://github.com/filecoin-project/lotus/blob/master/api/api_full.go)
+* [Storage miner API](https://github.com/filecoin-project/lotus/blob/master/api/api_storage.go)
 
 The necessary permissions for each are in [api/struct.go](https://github.com/filecoin-project/lotus/blob/master/api/struct.go).
 

documentation/en/hardware-mining.md

@@ -1,5 +1,46 @@
 # Mining Hardware
 
-> This page is a work in progress. EVERYTHING HERE CAN CHANGE AND WILL CHANGE. PURCHASE HARDWARE AT YOUR OWN RISK.
+> This documentation page describes the standard testing configuration the Protocol Labs team has used to test **Lotus Storage Miner**s on Lotus. There is no guarantee this testing configuration will be suitable for Filecoin storage mining at MainNet launch. If you need to buy new hardware to join the Filecoin TestNet, we recommend to buy no more hardware than you require for testing. To learn more please read this [hardware blog post](https://filecoin.io/blog/filecoin-testnet-mining/)
 
-Please check out this [GitHub issue](https://github.com/filecoin-project/lotus/issues/694) to see benchmarks from existing hardware setups if you plan on participating in the **Filecoin TestNet**
+**Sector sizes** and **minimum pledged storage** required to mine blocks are two very important Filecoin TestNet parameters that impact hardware decisions. We will continue to refine all parameters during TestNet. 
+
+BECAUSE OF THIS, OUR STANDARD TESTING CONFIGURATION FOR FILECOIN MAINNET CAN AND WILL CHANGE. YOU HAVE BEEN WARNED.
+
+## Example configuration
+
+The setup below is a minimal example for sealing 32 GiB sectors on Lotus:
+
+* 3 TB of hard drive space.
+* 8 to 12 core CPU
+* 256 GB of RAM
+
+## Benchmarked GPUs
+
+GPUs are a must for getting **block rewards**. Here are a few that have been tried in the past:
+
+* GeForce RTX 2080 Ti
+* GeForce RTX 2080 SUPER
+* GeForce RTX 2080
+* GeForce GTX 1080 Ti
+* GeForce GTX 1080
+* GeForce GTX 1060
+
+## Testing other GPUs
+
+If you want to test other GPUs, such as the GeForce GTX 1660, you can use the following configuration flag:
+
+```sh
+BELLMAN_CUSTOM_GPU="<NAME>:<NUMBER_OF_CORES>"
+```
+
+Here is an example of trying a GeForce GTX 1660 ti with 1536 cores.
+
+```sh
+BELLMAN_CUSTOM_GPU="GeForce GTX 1660 Ti:1536"
+```
+
+To get the number of cores for your GPU, you will need to check your cards specifications.
+
+## Benchmarking
+
+Here is a [benchmarking tool](https://github.com/filecoin-project/lotus/tree/testnet-staging/cmd/lotus-bench) and a [GitHub issue thread](https://github.com/filecoin-project/lotus/issues/694) for those who wish to experiment with and contribute hardware setups for the **Filecoin TestNet**.

documentation/en/join-devnet.md

@@ -55,7 +55,7 @@ t3vhfme4qfvegqaz7m7q6o6afjcs67n6kpzv7t2eozio4chwpafwa2y4l7zhwd5eom7jmihzdg4s52dp
 
 ## Check wallet address balance
 
-Wallet balances in the devnet are in **FIL**, the smallest denomination of FIL is an **attoFil**, where 1 attoFil = 10^-18 FIL.
+Wallet balances in the Lotus DevNet are in **FIL**, the smallest denomination of FIL is an **attoFil**, where 1 attoFil = 10^-18 FIL.
 
 ```sh
 lotus wallet balance <YOUR_NEW_ADDRESS>
@@ -63,6 +63,14 @@ lotus wallet balance <YOUR_NEW_ADDRESS>
 
 You will not see any attoFIL in your wallet if your **chain** is not fully synced.
 
+## Send FIL to another wallet
+
+To send FIL to another wallet, use this command:
+
+```
+lotus send <target> <amount>
+```
+
 ## Monitor the dashboard
 
 To see the latest network activity, including **chain block height**, **block height**, **blocktime**, **total network power**, largest **block producer miner**, check out the [monitoring dashboard](https://lotus-metrics.kittyhawk.wtf).

documentation/en/mining.md

@@ -50,7 +50,7 @@ To mine:
 lotus-storage-miner run
 ```
 
-If you are downloading **Filecoin Parameters**, the download can take some time.
+If you are downloading **Filecoin Proof Parameters**, the download can take some time.
 
 Get information about your miner:
 

documentation/en/retrieving-data.md

@@ -2,7 +2,7 @@
 
 > There are recent bug reports with these instructions. If you happen to encounter any problems, please create a [GitHub issue](https://github.com/filecoin-project/lotus/issues/new) and a maintainer will address the problem as soon as they can.
 
-Here are the operations you can perform after you have stored a **Data CID** with the **Lotus Storage Miner** in the network.
+Here are the operations you can perform after you have stored and sealed a **Data CID** with the **Lotus Storage Miner** in the network.
 
 If you would like to learn how to store a **Data CID** on a miner, read the instructions [here](https://docs.lotu.sh/en+storing-data).
 

documentation/en/setup-troubleshooting.md

@@ -23,6 +23,12 @@ ERROR hello hello/hello.go:81 other peer has different genesis!
 
 * Try deleting your file system's `~/.lotus` directory. Check that it exists with `ls ~/.lotus`.
 
+```sh
+- repo is already locked
+```
+
+* You already have another lotus deamon running.
+
 ## Failed messages
 
 Some errors will occur that do not prevent Lotus from working:

documentation/en/storing-data-troubleshooting.md

@@ -11,3 +11,13 @@ WARN  main  lotus/main.go:72  failed to start deal: computing commP failed: gene
 ```
 
 * There is a minimum file size of 127 bytes.
+
+## Troubleshooting Sealing
+
+Miners can check sealing progress with this command:
+
+```sh
+lotus-storage-miner sectors list
+```
+
+When sealing is complete, `pSet: NO` will become `pSet: YES`. From now on the **Data CID** is [retrievable](https://docs.lotu.sh/en+retrieving-data) from the **Lotus Storage Miner**.

documentation/en/storing-data.md

@@ -52,4 +52,4 @@ lotus client deal <Data CID> <miner> <price> <duration>
 
 Upon success, this command will return a **Deal CID**. 
 
-From now on the **Data CID** is [retrievable](https://docs.lotu.sh/en+retrieving-data) from the **Lotus Storage Miner**.
+To retrieve this file it must be sealed. If the **Lotus Storage Miner** is not running on a machine designed for sealing, the process will take a very long time.