High-Level Documentation (#565)
* High level docs - start. * Clean up README * Start adding details to high level docs * More docs on the header sync pallet * Testing scenarios document. * Add some scenarios. * Add multi-sig scenario. * Start writing about message dispatch pallet * Move content from old README into PoA specific doc * Apply suggestions from code review Co-authored-by:Andreas Doerr <adoerr@users.noreply.github.com> * GRANDPA for consistency. * Describe scenario steps. * WiP * Add notes about block production and forks * Update. * Add sequence diagram for Millau to Rialto transfer * Clean up header sync pallet overview * Remove leftover example code * Clean up testing scenarios and amend sequence diagram. * Linking docs. * Add some more docs. * Do a bit of cleanup on the high-level docs * Clean up the testing scenario * Fix typos in flow charts * Fix small typo * Fix indentation of Rust block * Another attempt at rendering block correctly * TIL about lazy list numbering in Markdown * Add list numbers across sections * Start counting from correct number * Update README to use correct path to local scripts * Wrap ASCII art in code block Co-authored-by:
Tomasz Drwięga <tomasz@parity.io> Co-authored-by:
Tomasz Drwięga <tomusdrw@users.noreply.github.com> Co-authored-by:
Andreas Doerr <adoerr@users.noreply.github.com>
Showing
- bridges/README.md 78 additions, 160 deletionsbridges/README.md
- bridges/docs/high-level-overview.md 177 additions, 0 deletionsbridges/docs/high-level-overview.md
- bridges/modules/substrate/src/fork_tests.rs 3 additions, 3 deletionsbridges/modules/substrate/src/fork_tests.rs
- bridges/modules/substrate/src/justification.rs 2 additions, 2 deletionsbridges/modules/substrate/src/justification.rs
- bridges/modules/substrate/src/lib.rs 8 additions, 8 deletionsbridges/modules/substrate/src/lib.rs
- bridges/modules/substrate/src/storage.rs 5 additions, 5 deletionsbridges/modules/substrate/src/storage.rs
- bridges/modules/substrate/src/verifier.rs 6 additions, 6 deletionsbridges/modules/substrate/src/verifier.rs
- bridges/primitives/runtime/src/chain.rs 1 addition, 1 deletionbridges/primitives/runtime/src/chain.rs
Please register or sign in to comment