lint markdown docs using a stop-words and write-good linters (tendermint#2195)

* lint docs with write-good, stop-words

* remove package-lock.json

* update changelog

* fix wrong paragraph formatting

* fix some docs formatting

* fix docs format

* fix abci spec format

Author: nylira

CHANGELOG_PENDING.md

@@ -23,6 +23,7 @@ FEATURES:
 - [types] allow genesis file to have 0 validators ([#2015](https://github.com/tendermint/tendermint/issues/2015))
 
 IMPROVEMENTS:
+- [docs] Lint documentation with `write-good` and `stop-words`.
 - [scripts] Added json2wal tool, which is supposed to help our users restore
   corrupted WAL files and compose test WAL files (@bradyjoestar)
 

docs/.textlintrc.json

@@ -0,0 +1,9 @@
+{
+  "rules": {
+    "stop-words": {
+      "severity": "warning",
+      "defaultWords": false,
+      "words": "stop-words.txt"
+    }
+  }
+}

docs/app-dev/ecosystem.json

@@ -5,24 +5,21 @@
       "url": "https://github.com/cosmos/cosmos-sdk",
       "language": "Go",
       "author": "Cosmos",
-      "description":
-        "A prototypical account based crypto currency state machine supporting plugins"
+      "description": "A prototypical account based crypto currency state machine supporting plugins"
     },
     {
       "name": "cb-ledger",
       "url": "https://github.com/block-finance/cpp-abci",
       "language": "C++",
       "author": "Block Finance",
-      "description":
-        "Custodian Bank Ledger, integrating central banking with the blockchains of tomorrow"
+      "description": "Custodian Bank Ledger, integrating central banking with the blockchains of tomorrow"
     },
     {
       "name": "Clearchain",
       "url": "https://github.com/tendermint/clearchain",
       "language": "Go",
       "author": "FXCLR",
-      "description":
-        "Application to manage a distributed ledger for money transfers that support multi-currency accounts"
+      "description": "Application to manage a distributed ledger for money transfers that support multi-currency accounts"
     },
     {
       "name": "Ethermint",
@@ -43,8 +40,7 @@
       "url": "https://github.com/hyperledger/burrow",
       "language": "Go",
       "author": "Monax Industries",
-      "description":
-        "Ethereum Virtual Machine augmented with native permissioning scheme and global key-value store"
+      "description": "Ethereum Virtual Machine augmented with native permissioning scheme and global key-value store"
     },
     {
       "name": "Merkle AVL Tree",
@@ -72,8 +68,7 @@
       "url": "https://github.com/trusch/passchain",
       "language": "Go",
       "author": "trusch",
-      "description":
-        "Tool to securely store and share passwords, tokens and other short secrets"
+      "description": "Tool to securely store and share passwords, tokens and other short secrets"
     },
     {
       "name": "Passwerk",
@@ -87,8 +82,7 @@
       "url": "https://github.com/davebryson/py-tendermint",
       "language": "Python",
       "author": "Dave Bryson",
-      "description":
-        "A Python microframework for building blockchain applications with Tendermint"
+      "description": "A Python microframework for building blockchain applications with Tendermint"
     },
     {
       "name": "Stratumn SDK",
@@ -102,16 +96,14 @@
       "url": "https://github.com/keppel/lotion",
       "language": "Javascript",
       "author": "Judd Keppel",
-      "description":
-        "A Javascript microframework for building blockchain applications with Tendermint"
+      "description": "A Javascript microframework for building blockchain applications with Tendermint"
     },
     {
       "name": "Tendermint Blockchain Chat App",
       "url": "https://github.com/SaifRehman/tendermint-chat-app/",
       "language": "Javascript",
       "author": "Saif Rehman",
-      "description":
-        "This is a minimal chat application based on Tendermint using Lotion.js in 30 lines of code!. It also includes web/mobile application built using Ionic 3."
+      "description": "This is a minimal chat application based on Tendermint using Lotion.js in 30 lines of code!. It also includes web/mobile application built using Ionic 3."
     },
     {
       "name": "BigchainDB",
@@ -184,16 +176,14 @@
       "url": "https://github.com/tendermint/tools",
       "technology": "Docker and Kubernetes",
       "author": "Tendermint",
-      "description":
-        "Deploy a Tendermint test network using Google's kubernetes"
+      "description": "Deploy a Tendermint test network using Google's kubernetes"
     },
     {
       "name": "terraforce",
       "url": "https://github.com/tendermint/tools",
       "technology": "Terraform",
       "author": "Tendermint",
-      "description":
-        "Terraform + our custom terraforce tool; deploy a production Tendermint network with load balancing over multiple AWS availability zones"
+      "description": "Terraform + our custom terraforce tool; deploy a production Tendermint network with load balancing over multiple AWS availability zones"
     },
     {
       "name": "ansible-tendermint",

docs/architecture/adr-002-event-subscription.md

@@ -7,8 +7,7 @@ a subset of transactions** (rather than all of them) using `/subscribe?event=X`.
 example, I want to subscribe for all transactions associated with a particular
 account. Same for fetching. The user may want to **fetch transactions based on
 some filter** (rather than fetching all the blocks). For example, I want to get
-all transactions for a particular account in the last two weeks (`tx's block
-time >= '2017-06-05'`).
+all transactions for a particular account in the last two weeks (`tx's block time >= '2017-06-05'`).
 
 Now you can't even subscribe to "all txs" in Tendermint.
 

docs/architecture/adr-004-historical-validators.md

@@ -3,11 +3,11 @@
 ## Context
 
 Right now, we can query the present validator set, but there is no history.
-If you were offline for a long time, there is no way to reconstruct past validators.  This is needed for the light client and we agreed needs enhancement of the API.
+If you were offline for a long time, there is no way to reconstruct past validators. This is needed for the light client and we agreed needs enhancement of the API.
 
 ## Decision
 
-For every block, store a new structure that contains either the latest validator set, 
+For every block, store a new structure that contains either the latest validator set,
 or the height of the last block for which the validator set changed. Note this is not
 the height of the block which returned the validator set change itself, but the next block,
 ie. the first block it comes into effect for.
@@ -19,7 +19,7 @@ are updated frequently - for instance by only saving the diffs, rather than the
 
 An alternative approach suggested keeping the validator set, or diffs of it, in a merkle IAVL tree.
 While it might afford cheaper proofs that a validator set has not changed, it would be more complex,
-and likely less efficient. 
+and likely less efficient.
 
 ## Status
 

docs/architecture/adr-005-consensus-params.md

@@ -7,7 +7,7 @@ Since they may be need to be different in different networks, and potentially to
 networks, we seek to initialize them in a genesis file, and expose them through the ABCI.
 
 While we have some specific parameters now, like maximum block and transaction size, we expect to have more in the future,
-such as a period over which evidence is valid, or the frequency of checkpoints. 
+such as a period over which evidence is valid, or the frequency of checkpoints.
 
 ## Decision
 
@@ -45,22 +45,22 @@ type BlockGossip struct {
 
 The `ConsensusParams` can evolve over time by adding new structs that cover different aspects of the consensus rules.
 
-The `BlockPartSizeBytes` and the `BlockSize.MaxBytes` are enforced to be greater than 0. 
+The `BlockPartSizeBytes` and the `BlockSize.MaxBytes` are enforced to be greater than 0.
 The former because we need a part size, the latter so that we always have at least some sanity check over the size of blocks.
 
 ### ABCI
 
 #### InitChain
 
 InitChain currently takes the initial validator set. It should be extended to also take parts of the ConsensusParams.
-There is some case to be made for it to take the entire Genesis, except there may be things in the genesis, 
+There is some case to be made for it to take the entire Genesis, except there may be things in the genesis,
 like the BlockPartSize, that the app shouldn't really know about.
 
 #### EndBlock
 
 The EndBlock response includes a `ConsensusParams`, which includes BlockSize and TxSize, but not BlockGossip.
 Other param struct can be added to `ConsensusParams` in the future.
-The `0` value is used to denote no change. 
+The `0` value is used to denote no change.
 Any other value will update that parameter in the `State.ConsensusParams`, to be applied for the next block.
 Tendermint should have hard-coded upper limits as sanity checks.
 
@@ -83,4 +83,3 @@ Proposed.
 ### Neutral
 
 - The TxSize, which checks validity, may be in conflict with the config's `max_block_size_tx`, which determines proposal sizes
-