Merge pull request #556 from tellor-io/docs-workgroup-updates

Update docs based on workgroup feedback #2

docs/getting-started.md

@@ -1,7 +1,7 @@
 # Getting Started
 
 ## Prerequisites
-- An account with test TRB and your chain's native token. You can get test TRB from any Tellor playground contract [here](https://docs.tellor.io/tellor/the-basics/contracts-reference) by calling the `faucet` function with your address as the argument. For your chain's native token, there's usually a faucet available. For example, [Polygon's faucet](https://faucet.polygon.technology/) for reporting on Mumbai testnet.
+- An account with test TRB and your chain's native token. You can get test TRB from any Tellor playground contract [here](https://docs.tellor.io/tellor/the-basics/contracts-reference) by calling the `faucet` function with your address as the argument; however, for Polygon's Mumbai testnet and Ethereum's Goerli testnet, tweet @trbfaucet for test TRB on those chains. For your chain's native token, there's usually a faucet available. For example, [Polygon's faucet](https://faucet.polygon.technology/) for reporting on Mumbai testnet.
 - [Python 3.9](https://www.python.org/downloads/release/python-3915/) is required to install and use`telliot-feeds`. Alternatively, you can use our [docker](https://docs.docker.com/get-started/) release. 
 
 *If you're using docker, please follow the [Docker setup instructions](#optional-docker-setup).*
@@ -83,7 +83,7 @@ To view your current configuration at any time:
 The reporter (telliot) needs to know which accounts (wallet addresses) are available for submitting values to the oracle.
 Use the command line to add necessary reporting accounts/private keys.
 
-For example, to add an account called `my-matic-acct` for reporting on Polygon mainnet (chain ID 137):
+For example, to add an account called `my-matic-acct` for reporting on Polygon mainnet (chain ID 137). You'll need to replace the private key in this example with the private key that holds your TRB for reporting:
 
     >> telliot account add my-matic-acct 0x57fe7105302229455bcfd58a8b531b532d7a2bb3b50e1026afa455cd332bf706 137
     Enter encryption password for my-matic-acct: 
@@ -99,13 +99,15 @@ then you'll be set to report.
 
 ### Configure endpoints
 
-You can add your RPC endpoints via the command line or by editing the `endpoints.yaml` file. To edit them via the command line, use the following command:
+You can add your RPC endpoints via the command line or by editing the `endpoints.yaml` file. For example, using [nano](https://www.nano-editor.org/):
+
+    nano ~/telliot/endpoints.yaml
 
-    telliot -a myacct report
+To configure your endpoint via the CLI, use the following command:
 
-Edit `~/telliot/endpoints.yaml` to configure Telliot to use your own endpoints.
+    telliot -a myacct report
 
-If you don't have your own endpoint, a free one can be obtained at [Infura.io](http://www.infura.io).  Simply replace `INFURA_API_KEY` with the one provided by Infura.
+If you don't have your own node URL, a free one can be obtained at [Infura.io](http://www.infura.io).  Simply replace `INFURA_API_KEY` with the one provided by Infura.
 
 For the funcitonality of telliot feeds, Endpoints should be configured for both Ethereum mainnet and Goerli testnet. (even if you don't plan on reporting oracle data on those networks)
 

docs/usage.md

@@ -18,6 +18,8 @@ $ telliot -a acct1 report -ncr -qt trb-usd-spot
 
 # Reporting Basics
 
+**Note: When using the `report` command, `telliot` will automatically attempt to stake the minimum required to report. To see the current stake amount, find the oracle contract on your desired chain [here](https://docs.tellor.io/tellor/the-basics/contracts-reference), then call `getStakeAmount` in the contract's read functions section on the block explorer. The returned value is denominated in wei.**
+
 ## Help flag
 
 Use the help flag to view all available commands and option flags:
@@ -108,6 +110,26 @@ Use the `report` command to submit data to Tellor oracles. Example `report` comm
 telliot -a acct2 report
 ```
 
+When calling the `report` command, `telliot` will ask you to confirm the reporter's settings:
+
+```
+...
+Reporting query tag: eth-usd-spot
+Current chain ID: 80001
+Expected percent profit: 100.0%
+Transaction type: 0
+Gas Limit: 350000
+Legacy gas price (gwei): None
+Max fee (gwei): None
+Priority fee (gwei): None
+Gas price speed: fast
+Desired stake amount: 10.0
+Minimum native token balance: 0.25 MATIC
+
+Press [ENTER] to confirm settings.
+```
+The default settings are probably fine to use on testnets, but you may want to adjust them for mainnet using the `report` command flags/options.
+
 By default, the reporter will continue to attempt reporting whenever out of reporting lock. Use the `--submit-once` flag to only report once:
 
 ```