From 89047d8ebd7a06a4a538bc3817a858fbd7e71d2d Mon Sep 17 00:00:00 2001 From: Rigel Date: Wed, 31 Oct 2018 07:07:06 -0400 Subject: [PATCH] Merge PR #2642: Add todo diagrams --- docs/PRIORITIES.md | 2 ++ docs/resources/diagrams/todo.md | 17 +++++++++++++++++ 2 files changed, 19 insertions(+) create mode 100644 docs/resources/diagrams/todo.md diff --git a/docs/PRIORITIES.md b/docs/PRIORITIES.md index 02aa495bbb..522f1b8660 100644 --- a/docs/PRIORITIES.md +++ b/docs/PRIORITIES.md @@ -36,6 +36,8 @@ - Tags [#1780](https://github.com/cosmos/cosmos-sdk/issues/1780) # Lower priority +- Create some diagrams (see `docs/resources/diagrams/todo.md`) + ## Governance v2 - Circuit breaker - https://github.com/cosmos/cosmos-sdk/issues/926 diff --git a/docs/resources/diagrams/todo.md b/docs/resources/diagrams/todo.md new file mode 100644 index 0000000000..b032b55cf1 --- /dev/null +++ b/docs/resources/diagrams/todo.md @@ -0,0 +1,17 @@ +The following diagrams should be created to aid in comprehension of the SDK: + - Genesis circuit + - App structure (aka use of baseapp in something like gaia) + - Simulation framework + - Slashing Mechanism + - Staking Mechanism + - Staking/Slashing Mechanism specific to use of hooks + - Governance Mechanism + - Distribution Mechanism + - Inflation Mechanism (easier) + - IBC Mechanism + +These diagrams should reference specific structs/interfaces from the codebase, +logic flow and interconnectivity with other mechanisms etc. It's recommended that +https://www.draw.io/ be used, hence the raw diagram xml can be saved directly to +the Cosmos-SDK repo and adapted with the codebase. +