Merge pull request #713 from braydonf/docs

Docs formatting and consistency

Author: braydonf

CHANGELOG.md

@@ -1,4 +1,4 @@
-# Bcoin Release Notes & Changelog
+# Bcoin release notes & changelog
 
 ## v2.0.0
 
@@ -136,7 +136,7 @@ prefix directory. For example `--prefix ~/.bcoin_whatever --network testnet`
 will create a directory structure of `~/.bcoin_whatever/testnet/` instead of
 `~/.bcoin_whatever`. Please update your directory structure accordingly.
 
-### Configuration Changes
+### Configuration changes
 
 Wallet and Node are now separated and use different persistent configuration files.
 Some configuration options have moved to `wallet.conf`, which is stored in the prefix
@@ -168,14 +168,14 @@ Example using CLI options:
 Example using ENV:
 `BCOIN_NETWORK=simnet BCOIN_HTTP_HOST=0.0.0.0 BCOIN_WALLET_HTTP_HOST=0.0.0.0 BCOIN_WALLET_API_KEY=hunter2 BCOIN_WALLET_WALLET_AUTH=true ./bin/node`
 
-### Bcoin Client Changes
+### Bcoin client changes
 
 The `bcoin cli` interface has been deprecated and is now replaced with a
 separate tool: `bcoin-cli`. `bcoin wallet` has also been deprecated and is
 replaced with `bwallet-cli`. Both `bcoin-cli` and `bwallet-cli` can be
 installed with the `bclient` package in npm.
 
-### Wallet API Changes
+### Wallet API changes
 
 The main wallet API changes have to do with changes in the structure of the
 HTTP server itself. The bcoin wallet HTTP server will now always listen on it's
@@ -206,7 +206,7 @@ example, `GET /backup?token=xxx...`. It also allows access to any wallet on the
 HTTP or websocket layer (websockets who use the admin token can join a wallet
 of `*`, which notifies them of events on _all_ wallets).
 
-### Notable Changes
+### Notable changes
 
 - __wallet/http__ - A `conflict` event will be correctly emitted for _all_
   double spends.
@@ -227,18 +227,18 @@ of `*`, which notifies them of events on _all_ wallets).
 
 ## v1.0.0-beta.15
 
-### Notable Changes
+### Notable changes
 
 ## v1.0.0-beta.14
 
-### Notable Changes
+### Notable changes
 
 - __pkg__ - Ignored `bcoin*` files in npmignore have been removed. This fixes
   the npm install.
 
 ## v1.0.0-beta.13
 
-### Notable Changes
+### Notable changes
 
 - __config__ - Options using megabyte units are now calculated properly again
   (6182df044228f9215938e7d314435f3f2640acca,
@@ -356,22 +356,22 @@ Becomes this:
 
 ## v1.0.0-beta.12
 
-### Notable Changes
+### Notable changes
 
 - __networks__ - Fixed simnet wpkh prefix.
 - __http__ - `wallet join` without wallet auth has been fixed for responses.
   This was causing a hanging issue with the client.
 
 ## v1.0.0-beta.11
 
-### Notable Changes
+### Notable changes
 
 - __networks__ - Simnet params have been fixed.
 - __cli__ - Chain reset call has been fixed.
 
 ## v1.0.0-beta.10
 
-### Notable Changes
+### Notable changes
 
 - __wallet/http__ - Create wallet route modified
   (`POST /wallet/:id?` changed to `PUT /wallet/:id`).
@@ -407,7 +407,7 @@ Becomes this:
 
 ## v1.0.0-beta.9
 
-### Notable Changes
+### Notable changes
 
 - __mempool__ - Trimming now removes dependency chains by cumulative fee rate.
 - __mempool__ - Cumulative descendant fees are now updated properly when
@@ -419,14 +419,14 @@ Becomes this:
 
 ## v1.0.0-beta.8
 
-### Notable Changes
+### Notable changes
 
 - __mempool__ - Fixed critical fee estimator bug causing throwing in the
   mempool.
 
 ## v1.0.0-beta.7
 
-### Notable Changes
+### Notable changes
 
 - __http__ - Always display spent coins in tx routes (e.g. `/tx/[txid]`).
 - __mempool__ - An on-disk mempool is now exposed via `--persistent-mempool`
@@ -438,42 +438,42 @@ Becomes this:
 
 ## v1.0.0-beta.6
 
-### Notable Changes
+### Notable changes
 
 - __http__ - Better bitcoind compatability for JSON-RPC.
 
 ## v1.0.0-beta.5
 
-### Notable Changes
+### Notable changes
 
 - __miner__ - Better fee rate comparisons.
 - __deps__ - Upgrade deps, fix build on arm and windows.
 
 ## v1.0.0-beta.4
 
-### Notable Changes
+### Notable changes
 
 - __miner__ - Optimized TX sorting.
 - __rpc__ - Improved getblocktemplate to provide more
   accurate results to bitcoind.
 
 ## v1.0.0-beta.3
 
-### Notable Changes
+### Notable changes
 
 - __miner__ - Improved fee rate sorting.
 - __rpc__ - Fix incompatibilities in rpc api (getblocktemplate & submitblock).
 
 ## v1.0.0-beta.2
 
-### Notable Changes
+### Notable changes
 
 - __pool__ - Increase max header chain failures to 500 (prevents the initial
   sync from reverting to getblocks so frequently).
 
 ## v1.0.0-beta.1
 
-### Notable Changes
+### Notable changes
 
 - __wsproxy__: Fixed proof of work handling in websocket proxy (43c491b).
 - __chain__: Optimized MTP and network target calculations (1e07d1b).
@@ -485,6 +485,6 @@ Becomes this:
 
 ## v1.0.0-beta
 
-### Notable Changes
+### Notable changes
 
 - Initial tagged release.

README.md

@@ -36,13 +36,14 @@ $ npm install
 $ ./bin/bcoin
 ```
 
-See the [Beginner's Guide][guide] for more in-depth installation instructions.
+See the [Getting started][guide] guide for more in-depth installation
+instructions, including verifying releases.
 
 ## Documentation
 
-- API Docs: https://bcoin.io/docs/
-- REST Docs: https://bcoin.io/api-docs/
-- Docs: [docs/](docs/README.md)
+- General docs: [docs/](docs/README.md)
+- Wallet and node API docs: https://bcoin.io/api-docs/
+- Library API docs: https://bcoin.io/docs/
 
 ## Support
 
@@ -68,10 +69,10 @@ all code is your original work. `</legalese>`
 See LICENSE for more info.
 
 [purse]: https://purse.io
-[guide]: https://github.com/bcoin-org/bcoin/blob/master/docs/Beginner's-Guide.md
+[guide]: docs/getting-started.md
 [freenode]: https://freenode.net/
 [irc]: irc://irc.freenode.net/bcoin
-[changelog]: https://github.com/bcoin-org/bcoin/blob/master/CHANGELOG.md
+[changelog]: CHANGELOG.md
 
 [coverage-status-img]: https://codecov.io/gh/bcoin-org/bcoin/badge.svg?branch=master
 [coverage-status-url]: https://codecov.io/gh/bcoin-org/bcoin?branch=master

docs/README.md

@@ -1,28 +1,44 @@
-## Getting Started
-- [Getting Started](Beginner's-Guide.md)
-- [Configuration](Configuration.md)
-- [Wallet System](Wallet-System.md)
-- [Design](Design.md)
-- [Guides](https://bcoin.io/guides.html)
+# Documentation
+
+## Table of contents
+
+- [Getting started](getting-started.md)
+- [Configuration](configuration.md)
+- [Wallet system](wallet-system.md)
+- [Design](design.md)
+- [Node and wallet CLI](cli.md)
 
-## Running
-- [Bcoin CLI](CLI.md)
-- [Running in the Browser](https://bcoin.io/guides/browser.html)
-- [REST and RPC API](https://bcoin.io/api-docs/index.html#introduction)
+## External links
+
+- [Guides](https://bcoin.io/guides.html)
+- [Running in the browser](https://bcoin.io/guides/browser.html)
+- [Node and wallet REST and RPC API](https://bcoin.io/api-docs/index.html)
 
-## Code Examples
+## Library examples
 
 These code examples are designed to demonstrate how to integrate bcoin modules
 with minimal configuration.
 
-- [Simple Fullnode](Examples/fullnode.js) - Creates a `FullNode` object and connects to `testnet`.
-- [Connect to Peer](Examples/connect-to-peer.js) - Connects to a user-defined peer in `regtest` mode.
-- [Connecting to the P2P Network](Examples/connect-to-the-p2p-network.js) - Creates `chain`, `pool`, and `mempool` objects for both main and testnet networks.
-- [Creating a Blockchain and Mempool](Examples/create-a-blockchain-and-mempool.js) - Mines a block from the mempool to the chain.
-- [Wallet with Dummy TX](Examples/wallet.js) - Adds a "dummy" transaction to the wallet and `tx` event is handled.
-- [SPV Sync](Examples/spv-sync-wallet.js) - A transaction matching the SPV node's bloom filter is broadcast by a minimal full node to the SPV node.
-- [Plugin Example](Examples/peers-plugin.js) - Demonstrates the `plugin` feature of bcoin's `node` object.
-- [Client API Usage](Examples/client-api.js) - Demonstrates usage of the node and wallet API.
-- [Create and Sign TX](Examples/create-sign-tx.js) - Demonstrates how to use `mtx` and `keyring` modules to sign a transaction.
-- [Get Transaction from Chain](Examples/get-tx-from-chain.js) - Connects to live testnet network and syncs the first 1000 blocks with tx indexing active.
-- [Create Watch Only Wallet](Examples/watch-only-wallet.js) - Imports an `xpub` into a new watch-only wallet that can derive addresses.
+- [Simple fullnode](examples/fullnode.js) - Creates a `FullNode` object and
+  connects to `testnet`.
+- [Connect to peer](examples/connect-to-peer.js) - Connects to a user-defined
+  peer in `regtest` mode.
+- [Connecting to the P2P network](examples/connect-to-the-p2p-network.js) -
+  Creates `chain`, `pool`, and `mempool` objects for both main and
+  testnet networks.
+- [Creating a blockchain and mempool](examples/create-a-blockchain-and-mempool.js) -
+  Mines a block from the mempool to the chain.
+- [Wallet with dummy TX](examples/wallet.js) - Adds a "dummy" transaction to
+  the wallet and `tx` event is handled.
+- [SPV sync](examples/spv-sync-wallet.js) - A transaction matching the SPV
+  node's bloom filter is broadcast by a minimal full node to the SPV node.
+- [Plugin example](examples/peers-plugin.js) - Demonstrates the `plugin`
+  feature of bcoin's `node` object.
+- [Client API usage](examples/client-api.js) - Demonstrates usage of the node
+  and wallet API.
+- [Create and sign TX](examples/create-sign-tx.js) - Demonstrates how to use
+  `mtx` and `keyring` modules to sign a transaction.
+- [Get transaction from chain](examples/get-tx-from-chain.js) - Connects to
+  live testnet network and syncs the first 1000 blocks with tx indexing active.
+- [Create watch only wallet](examples/watch-only-wallet.js) - Imports an `xpub`
+  into a new watch-only wallet that can derive addresses.

docs/CLI.md docs/cli.md

@@ -1,5 +1,8 @@
-Bcoin ships with [bclient](https://github.com/bcoin-org/bclient) as its default client
-to the [API](https://bcoin.io/api-docs) for command line access.
+# Node and wallet CLI
+
+Bcoin ships with [bclient](https://github.com/bcoin-org/bclient) as its
+default client to the [API](https://bcoin.io/api-docs) for command
+line access.
 
 ## Configuration
 
@@ -17,7 +20,8 @@ With command-line arguments:
 $ bcoin-cli --network=testnet --api-key=hunter2 info
 ```
 
-You can also use `~/.bcoin/bcoin.conf` for configuration options, see [Configuration](Configuration.md) for the full details.
+You can also use `~/.bcoin/bcoin.conf` for configuration options,
+see [Configuration](configuration.md) for the full details.
 
 ## Examples
 
@@ -66,4 +70,4 @@ $ bcoin-cli help
 $ bcoin-cli rpc help
 $ bwallet-cli help
 $ bwallet-cli rpc help
-```
+```