Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

R4R: Add list recommended diagrams #2642

Merged
merged 1 commit into from
Oct 31, 2018
Merged

R4R: Add list recommended diagrams #2642

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/PRIORITIES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
17 changes: 17 additions & 0 deletions docs/resources/diagrams/todo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.