[develop] Documentation patch 1 update

README.md

@@ -24,9 +24,9 @@ Some of the groundbreaking features of EOSIO include:
 
 Block.one is neither launching nor operating any initial public blockchains based upon the EOSIO software. This release refers only to version 1.0 of our open source software. We caution those who wish to use blockchains built on EOSIO to carefully vet the companies and organizations launching blockchains based on EOSIO before disclosing any private keys to their derivative software.
 
-## Testnets
+## Official Testnet
 
-There is no public testnet running currently.
+[testnet.eos.io](https://testnet.eos.io/)
 
 ## Supported Operating Systems
 

docs/00_install/00_install-prebuilt-binaries.md

@@ -13,50 +13,50 @@ Prebuilt EOSIO software packages are available for the operating systems below.
 
 #### Mac OS X Brew Install
 ```sh
-$ brew tap eosio/eosio
-$ brew install eosio
+brew tap eosio/eosio
+brew install eosio
 ```
 #### Mac OS X Brew Uninstall
 ```sh
-$ brew remove eosio
+brew remove eosio
 ```
 
 ### Ubuntu Linux:
 
 #### Ubuntu 18.04 Package Install
 ```sh
-$ wget https://github.com/eosio/eos/releases/download/v1.8.0-rc1/eosio_1.8.0-rc1-ubuntu-18.04_amd64.deb
-$ sudo apt install ./eosio_1.8.0-rc1-ubuntu-18.04_amd64.deb
+wget https://github.com/eosio/eos/releases/download/v1.8.0-rc1/eosio_1.8.0-rc1-ubuntu-18.04_amd64.deb
+sudo apt install ./eosio_1.8.0-rc1-ubuntu-18.04_amd64.deb
 ```
 #### Ubuntu 16.04 Package Install
 ```sh
-$ wget https://github.com/eosio/eos/releases/download/v1.8.0-rc1/eosio_1.8.0-rc1-ubuntu-16.04_amd64.deb
-$ sudo apt install ./eosio_1.8.0-rc1-ubuntu-16.04_amd64.deb
+wget https://github.com/eosio/eos/releases/download/v1.8.0-rc1/eosio_1.8.0-rc1-ubuntu-16.04_amd64.deb
+sudo apt install ./eosio_1.8.0-rc1-ubuntu-16.04_amd64.deb
 ```
 #### Ubuntu Package Uninstall
 ```sh
-$ sudo apt remove eosio
+sudo apt remove eosio
 ```
 
 ### RPM-based (CentOS, Amazon Linux, etc.):
 
 #### RPM Package Install
 ```sh
-$ wget https://github.com/eosio/eos/releases/download/v1.8.0-rc1/eosio-1.8.0-rc1.el7.x86_64.rpm
-$ sudo yum install ./eosio-1.8.0-rc1.el7.x86_64.rpm
+wget https://github.com/eosio/eos/releases/download/v1.8.0-rc1/eosio-1.8.0-rc1.el7.x86_64.rpm
+sudo yum install ./eosio-1.8.0-rc1.el7.x86_64.rpm
 ```
 #### RPM Package Uninstall
 ```sh
-$ sudo yum remove eosio
+sudo yum remove eosio
 ```
 
 ## Location of EOSIO binaries
 
 After installing the prebuilt packages, the actual EOSIO binaries will be located under:
 * `/usr/opt/eosio/<version-string>/bin` (Linux-based); or
-* `/usr/local/Cellar/eosio/<version-string>/bin` (MacOS )
+* `/usr/local/Cellar/eosio/<version-string>/bin` (MacOS)
 
-where `version-string` is the EOSIO version that was installed; e.g. `2.0.0-rc2`.
+where `version-string` is the EOSIO version that was installed.
 
 Also, soft links for each EOSIO program (`nodeos`, `cleos`, `keosd`, etc.) will be created under `usr/bin` or `usr/local/bin` to allow them to be executed from any directory.
 

docs/00_install/01_build-from-source/01_shell-scripts/01_download-eosio-source.md

@@ -5,26 +5,26 @@ content_title: Download EOSIO Source
 To download the EOSIO source code, clone the `eos` repo and its submodules. It is adviced to create a home `eosio` folder first and download all the EOSIO related software there:
 
 ```sh
-$ mkdir -p ~/eosio && cd ~/eosio
-$ git clone --recursive https://github.com/EOSIO/eos
+mkdir -p ~/eosio && cd ~/eosio
+git clone --recursive https://github.com/EOSIO/eos
 ```
 
 ## Update Submodules
 
 If a repository is cloned without the `--recursive` flag, the submodules *must* be updated before starting the build process:
 
 ```sh
-$ cd ~/eosio/eos
-$ git submodule update --init --recursive
+cd ~/eosio/eos
+git submodule update --init --recursive
 ```
 
 ## Pull Changes
 
 When pulling changes, especially after switching branches, the submodules *must* also be updated. This can be achieved with the `git submodule` command as above, or using `git pull` directly:
 
 ```sh
-$ [git checkout <branch>]  (optional)
-$ git pull --recurse-submodules
+[git checkout <branch>]  (optional)
+git pull --recurse-submodules
 ```
 
 [[info | What's Next?]]

docs/00_install/01_build-from-source/01_shell-scripts/02_build-eosio-binaries.md

@@ -8,8 +8,8 @@ content_title: Build EOSIO Binaries
 The build script first installs all dependencies and then builds EOSIO. The script supports these [Operating Systems](../../index.md#supported-operating-systems). To run it, first change to the `~/eosio/eos` folder, then launch the script:
 
 ```sh
-$ cd ~/eosio/eos
-$ ./scripts/eosio_build.sh
+cd ~/eosio/eos
+./scripts/eosio_build.sh
 ```
 
 The build process writes temporary content to the `eos/build` folder. After building, the program binaries can be found at `eos/build/programs`.

docs/00_install/01_build-from-source/01_shell-scripts/03_install-eosio-binaries.md

@@ -7,17 +7,17 @@ content_title: Install EOSIO Binaries
 For ease of contract development, content can be installed at the `/usr/local` folder using the `eosio_install.sh` script within the `eos/scripts` folder. Adequate permission is required to install on system folders:
 
 ```sh
-$ cd ~/eosio/eos
-$ sudo ./scripts/eosio_install.sh
+cd ~/eosio/eos
+sudo ./scripts/eosio_install.sh
 ```
 
 ## EOSIO manual install
 
 In lieu of the `eosio_install.sh` script, you can install the EOSIO binaries directly by invoking `make install` within the `eos/build` folder. Again, adequate permission is required to install on system folders:
 
 ```sh
-$ cd ~/eosio/eos/build
-$ sudo make install
+cd ~/eosio/eos/build
+sudo make install
 ```
 
 [[info | What's Next?]]

docs/00_install/01_build-from-source/01_shell-scripts/04_test-eosio-binaries.md

@@ -4,24 +4,7 @@ content_title: Test EOSIO Binaries
 
 Optionally, a set of tests can be run against your build to perform some basic validation of the EOSIO software installation.
 
-To run the test suite after building, start `mongod`:
-
-On Linux platforms:
-```sh
-~/opt/mongodb/bin/mongod -f ~/opt/mongodb/mongod.conf &
-```
-
-On MacOS:
-```sh
-/usr/local/bin/mongod -f /usr/local/etc/mongod.conf &
-```
-
-then set the build path to EOSIO_HOME:
-```sh
-export EOSIO_HOME=~/eosio/eos/build
-```
-
-then run `make test` on all platforms:
+To run the test suite after building, run:
 
 ```sh
 cd ~/eosio/eos/build

docs/00_install/01_build-from-source/01_shell-scripts/05_uninstall-eosio.md

@@ -5,8 +5,8 @@ content_title: Uninstall EOSIO
 If you have previously built EOSIO from source and now wish to install the prebuilt binaries, or to build from source again, it is recommended to run the `eosio_uninstall.sh` script within the `eos/scripts` folder:
 
 ```sh
-$ cd ~/eosio/eos
-$ sudo ./scripts/eosio_uninstall.sh
+cd ~/eosio/eos
+sudo ./scripts/eosio_uninstall.sh
 ```
 
 [[info | Uninstall Dependencies]]

docs/00_install/01_build-from-source/02_manual-build/00_eosio-dependencies.md

@@ -31,15 +31,15 @@ Regular users or application developers may prefer installing unpinned versions
 EOSIO dependencies can be built or installed automatically from the [Build Script](../01_shell-scripts/02_build-eosio-binaries.md) when building EOSIO from source. To build the pinned dependencies, the optional `-P` parameter can be specified when invoking the script. Otherwise, the unpinned dependencies will be installed instead, with the exception of `boost` and `cmake` which are always pinned:
 
 ```sh
-$ cd ~/eosio/eos
-$ ./scripts/eosio_build.sh [-P]
+cd ~/eosio/eos
+./scripts/eosio_build.sh [-P]
 ```
 
 ### Unupported Platforms
 
 EOSIO dependencies can also be built and installed manually by reproducing the same commands invoked by the [Build Script](../01_shell-scripts/02_build-eosio-binaries.md). The actual commands can be generated from the script directly by exporting specific environment variables and CLI parameters to the script when invoked:
 
 ```sh
-$ cd ~/eosio/eos
-$ export VERBOSE=true && export DRYRUN=true && ./scripts/eosio_build.sh -y [-P]
+cd ~/eosio/eos
+export VERBOSE=true && export DRYRUN=true && ./scripts/eosio_build.sh -y [-P]
 ```

docs/01_nodeos/02_usage/00_nodeos-options.md

@@ -6,7 +6,7 @@ content_title: Nodeos Options
 
 ## Nodeos-specific Options
 
-Nodeos-specific options are used mainly for housekeeping purposes, such as setting the directory where the blockchain data resides, specifying the name of the `nodeos` configuraton file, setting the name and path of the logging configuration file, etc. A sample output from running  `$ nodeos --help` is displayed below, showing the nodeos-specific options (Note: the plugin-specific options have been excluded for clarity):
+Nodeos-specific options are used mainly for housekeeping purposes, such as setting the directory where the blockchain data resides, specifying the name of the `nodeos` configuraton file, setting the name and path of the logging configuration file, etc. A sample output from running  `nodeos --help` is displayed below, showing the nodeos-specific options (Note: the plugin-specific options have been excluded for clarity):
 
 ```console
 Application Config Options:
@@ -30,7 +30,7 @@ Application Command Line Options:
 
 ## Plugin-specific Options
 
-Plugin-specific options control the behavior of the nodeos plugins. Every plugin-specific option has a unique name, so it can be specified in any order within the command line or `config.ini` file. When specifying one or more plugin-specific option(s), the applicable plugin(s) must also be enabled using the `--plugin` option or else the corresponding option(s) will be ignored. A sample output from running `$ nodeos --help` is displayed below, showing an excerpt from the plugin-specific options:
+Plugin-specific options control the behavior of the nodeos plugins. Every plugin-specific option has a unique name, so it can be specified in any order within the command line or `config.ini` file. When specifying one or more plugin-specific option(s), the applicable plugin(s) must also be enabled using the `--plugin` option or else the corresponding option(s) will be ignored. A sample output from running `nodeos --help` is displayed below, showing an excerpt from the plugin-specific options:
 
 ```console
 Config Options for eosio::chain_plugin:

docs/01_nodeos/02_usage/01_nodeos-configuration.md

@@ -2,7 +2,7 @@
 content_title: Nodeos Configuration
 ---
 
-The plugin-specific options can be configured using either CLI options or a configuration file, `config.ini`. Nodeos-specific options can only be configured from the command line. All CLI options and `config.ini` options can be found by running `$ nodeos --help` as shown above.
+The plugin-specific options can be configured using either CLI options or a configuration file, `config.ini`. Nodeos-specific options can only be configured from the command line. All CLI options and `config.ini` options can be found by running `nodeos --help` as shown above.
 
 Each `config.ini` option has a corresponding CLI option. However, not all CLI options are available in `config.ini`. For instance, most plugin-specific options that perform actions are not available in `config.ini`, such as `--delete-state-history` from `state_history_plugin`.
 
@@ -21,7 +21,7 @@ A custom `config.ini` file can be set by passing the `nodeos` option `--config p
 The example below shows a typical usage of `nodeos` when starting a block producing node:
 
 ```sh
-$ nodeos --replay-blockchain \
+nodeos --replay-blockchain \
   -e -p eosio \
   --plugin eosio::producer_plugin  \
   --plugin eosio::chain_api_plugin \
@@ -30,7 +30,7 @@ $ nodeos --replay-blockchain \
 ```
 
 ```sh
-$ nodeos \
+nodeos \
   -e -p eosio \
   --data-dir /users/mydir/eosio/data     \
   --config-dir /users/mydir/eosio/config \

docs/01_nodeos/02_usage/02_node-setups/00_producing-node.md

@@ -30,7 +30,7 @@ Please follow the steps below to set up a producing node:
 In order for your account to be eligible as a producer, you will need to register the account as a producer:
 
 ```sh
-$ cleos system regproducer accountname1 EOS1234534... http://producer.site Antarctica
+cleos system regproducer accountname1 EOS1234534... http://producer.site Antarctica
 ```
 
 ### 2. Set Producer Name
@@ -65,7 +65,7 @@ signature-provider = PUBLIC_SIGNING_KEY=KEY:PRIVATE_SIGNING_KEY
 ```
 
 #### Using Keosd:
-You can also use Keosd instead of hard-defining keys. 
+You can also use `keosd` instead of hard-defining keys. 
 
 ```console
 # config.ini:

docs/01_nodeos/02_usage/02_node-setups/01_non-producing-node.md

@@ -32,7 +32,7 @@ p2p-peer-address = 106.10.42.238:9876
 Or you can include the peer in as a boot flag when running `nodeos`, as follows:
 
 ```sh
-$ nodeos ... --p2p-peer-address=106.10.42.238:9876
+nodeos ... --p2p-peer-address=106.10.42.238:9876
 ```
 
 ### 2. Enable one or more available plugins

docs/01_nodeos/02_usage/03_development-environment/00_local-single-node-testnet.md

@@ -28,7 +28,7 @@ Open one "terminal" window and perform the following steps:
 Start your own single-node blockchain with this single command:
 
 ```sh
-$ nodeos -e -p eosio --plugin eosio::chain_api_plugin --plugin eosio::history_api_plugin
+nodeos -e -p eosio --plugin eosio::chain_api_plugin --plugin eosio::history_api_plugin
 ```
 
 [[info | Nodeos Minimal Options]]
@@ -53,12 +53,12 @@ At this point, `nodeos` is running with a single producer, `eosio`.
 Get info about the producing node:
 
 ```sh
-$ cleos get info
+cleos get info
 ```
 
 This should produce output that looks similar to this:
 
-```console
+```json
 {
   "server_version": "0f9df63e",
   "chain_id": "cf057bbfb72640471fd910bcb67639c22df9f92470936cddc1ade0e2f2e7dc4f",
@@ -108,7 +108,7 @@ The build seeds this folder with a default `genesis.json` file.  A configuration
 Now it should be possible to run `nodeos` and see it begin producing blocks.
 
 ```sh
-$ nodeos
+nodeos
 ```
 
 `nodeos` stores runtime data (e.g., shared memory and log content) in a custom data folder.  The location of this folder is determined by your system.