docs: add A TOC to the Readme.md of ADR Section (#3820)

* ADR TOC in readme.md * Added A TOC to the Readme.md of ADR Section - Added table of contents to the Readme of the architecture section. - Easier to traverse and when you know what is there. - If the Adr's become viewable online it would help guide the user Signed-off-by: Marko Baricevic <marbar3778@yahoo.com> * add tm-cmn to subprojects * normalize word
2026-01-06 21:36:26 +00:00 · 2019-07-19 19:29:33 +02:00
parent 816dfce8fe
commit 9e4cd19878
2 changed files with 57 additions and 21 deletions
--- a/README.md
+++ b/README.md
@@ -1,23 +1,21 @@
 # Tendermint
+
 ![banner](docs/tendermint-core-image.jpg)

 [Byzantine-Fault Tolerant](https://en.wikipedia.org/wiki/Byzantine_fault_tolerance)
 [State Machines](https://en.wikipedia.org/wiki/State_machine_replication).
-Or [Blockchain](https://en.wikipedia.org/wiki/Blockchain_(database)), for short.
+Or [Blockchain](<https://en.wikipedia.org/wiki/Blockchain_(database)>), for short.

 [![version](https://img.shields.io/github/tag/tendermint/tendermint.svg)](https://github.com/tendermint/tendermint/releases/latest)
-[![API Reference](
-https://camo.githubusercontent.com/915b7be44ada53c290eb157634330494ebe3e30a/68747470733a2f2f676f646f632e6f72672f6769746875622e636f6d2f676f6c616e672f6764646f3f7374617475732e737667
-)](https://godoc.org/github.com/tendermint/tendermint)
+[![API Reference](https://camo.githubusercontent.com/915b7be44ada53c290eb157634330494ebe3e30a/68747470733a2f2f676f646f632e6f72672f6769746875622e636f6d2f676f6c616e672f6764646f3f7374617475732e737667)](https://godoc.org/github.com/tendermint/tendermint)
 [![Go version](https://img.shields.io/badge/go-1.12.0-blue.svg)](https://github.com/moovweb/gvm)
 [![riot.im](https://img.shields.io/badge/riot.im-JOIN%20CHAT-green.svg)](https://riot.im/app/#/room/#tendermint:matrix.org)
 [![license](https://img.shields.io/github/license/tendermint/tendermint.svg)](https://github.com/tendermint/tendermint/blob/master/LICENSE)
 [![](https://tokei.rs/b1/github/tendermint/tendermint?category=lines)](https://github.com/tendermint/tendermint)

-
-Branch    | Tests | Coverage
----------|-------|----------
-master    | [![CircleCI](https://circleci.com/gh/tendermint/tendermint/tree/master.svg?style=shield)](https://circleci.com/gh/tendermint/tendermint/tree/master) | [![codecov](https://codecov.io/gh/tendermint/tendermint/branch/master/graph/badge.svg)](https://codecov.io/gh/tendermint/tendermint)
+| Branch | Tests                                                                                                                                                | Coverage                                                                                                                             |
+| ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
+| master | [![CircleCI](https://circleci.com/gh/tendermint/tendermint/tree/master.svg?style=shield)](https://circleci.com/gh/tendermint/tendermint/tree/master) | [![codecov](https://codecov.io/gh/tendermint/tendermint/branch/master/graph/badge.svg)](https://codecov.io/gh/tendermint/tendermint) |

 Tendermint Core is Byzantine Fault Tolerant (BFT) middleware that takes a state transition machine - written in any programming language -
 and securely replicates it on many machines.
@@ -49,9 +47,9 @@ For examples of the kinds of bugs we're looking for, see [SECURITY.md](SECURITY.

 ## Minimum requirements

-Requirement|Notes
---|---
-Go version | Go1.11.4 or higher
+| Requirement | Notes              |
+| ----------- | ------------------ |
+| Go version  | Go1.11.4 or higher |

 ## Documentation

@@ -145,20 +143,20 @@ Additional documentation is found [here](/docs/tools).

 ### Sub-projects

-* [Amino](http://github.com/tendermint/go-amino), reflection-based proto3, with
+- [Amino](http://github.com/tendermint/go-amino), reflection-based proto3, with
  interfaces
-* [IAVL](http://github.com/tendermint/iavl), Merkleized IAVL+ Tree implementation
+- [IAVL](http://github.com/tendermint/iavl), Merkleized IAVL+ Tree implementation
+- [Tm-cmn](http://github.com/tendermint/tm-cmn), Commonly used libs across Tendermint & Cosmos repos

 ### Applications

-* [Cosmos SDK](http://github.com/cosmos/cosmos-sdk); a cryptocurrency application framework
-* [Ethermint](http://github.com/cosmos/ethermint); Ethereum on Tendermint
-* [Many more](https://tendermint.com/ecosystem)
+- [Cosmos SDK](http://github.com/cosmos/cosmos-sdk); a cryptocurrency application framework
+- [Ethermint](http://github.com/cosmos/ethermint); Ethereum on Tendermint
+- [Many more](https://tendermint.com/ecosystem)

 ### Research

-* [The latest gossip on BFT consensus](https://arxiv.org/abs/1807.04938)
-* [Master's Thesis on Tendermint](https://atrium.lib.uoguelph.ca/xmlui/handle/10214/9769)
-* [Original Whitepaper](https://tendermint.com/static/docs/tendermint.pdf)
-* [Blog](https://blog.cosmos.network/tendermint/home)
-
+- [The latest gossip on BFT consensus](https://arxiv.org/abs/1807.04938)
+- [Master's Thesis on Tendermint](https://atrium.lib.uoguelph.ca/xmlui/handle/10214/9769)
+- [Original Whitepaper](https://tendermint.com/static/docs/tendermint.pdf)
+- [Blog](https://blog.cosmos.network/tendermint/home)
--- a/docs/architecture/README.md
+++ b/docs/architecture/README.md
@@ -20,3 +20,41 @@ it stands today.
 If recorded decisions turned out to be lacking, convene a discussion, record the new decisions here, and then modify the code to match.

 Note the context/background should be written in the present tense.
+
+### Table of Contents:
+
+- [ADR-001-Logging](./adr-001-logging.md)
+- [ADR-002-Event-Subscription](./adr-002-event-subscription.md)
+- [ADR-003-ABCI-APP-RPC](./adr-003-abci-app-rpc.md)
+- [ADR-004-Historical-Validators](./adr-004-historical-validators.md)
+- [ADR-005-Consensus-Params](./adr-005-consensus-params.md)
+- [ADR-006-Trust-Metric](./adr-006-trust-metric.md)
+- [ADR-007-Trust-Metric-Usage](./adr-007-trust-metric-usage.md)
+- [ADR-008-Priv-Validator](./adr-008-priv-validator.md)
+- [ADR-009-ABCI-Design](./adr-009-abci-design.md)
+- [ADR-010-Crypto-Changes](./adr-010-crypto-changes.md)
+- [ADR-011-Monitoring](./adr-011-monitoring.md)
+- [ADR-012-Peer-Transport](./adr-012-peer-transport.md)
+- [ADR-013-Symmetric-Crypto](./adr-013-symmetric-crypto.md)
+- [ADR-014-Secp-Malleability](./adr-014-secp-malleability.md)
+- [ADR-015-Crypto-Encoding](./adr-015-crypto-encoding.md)
+- [ADR-016-Protocol-Versions](./adr-016-protocol-versions.md)
+- [ADR-017-Chain-Versions](./adr-017-chain-versions.md)
+- [ADR-018-ABCI-Validators](./adr-018-abci-validators.md)
+- [ADR-019-Multisigs](./adr-019-multisigs.md)
+- [ADR-020-Block-Size](./adr-020-block-size.md)
+- [ADR-021-ABCI-Events](./adr-021-abci-events.md)
+- [ADR-022-ABCI-Errors](./adr-022-abci-errors.md)
+- [ADR-023-ABCI-Propose-tx](./adr-023-ABCI-propose-tx.md)
+- [ADR-024-Sign-Bytes](./adr-024-sign-bytes.md)
+- [ADR-025-Commit](./adr-025-commit.md)
+- [ADR-026-General-Merkle-Proof](./adr-026-general-merkle-proof.md)
+- [ADR-029-Check-Tx-Consensus](./adr-029-check-tx-consensus.md)
+- [ADR-030-Consensus-Refactor](./adr-030-consensus-refactor.md)
+- [ADR-033-Pubsub](./adr-033-pubsub.md)
+- [ADR-034-Priv-Validator-File-Structure](./adr-034-priv-validator-file-structure.md)
+- [ADR-035-Documentation](./adr-035-documentation.md)
+- [ADR-037-Deliver-Block](./adr-037-deliver-block.md)
+- [ADR-039-Peer-Behaviour](./adr-039-peer-behaviour.md)
+- [ADR-041-Proposer-Selection-via-ABCI](./adr-041-proposer-selection-via-abci.md)
+- [ADR-043-Blockchain-RiRi-Org](./adr-043-blockchain-riri-org.md)