Skip to content
This repository was archived by the owner on Nov 15, 2023. It is now read-only.

Commit 2dbfac3

Browse files
authored
Message and Data Type Flow Visualizations (#2286)
* start graphing message flow between subsystems This commit includes messages originating from the first three subsystems (alphabetically). * use standard arrowhead names * add messages from bitfield distribution && use circo layout * finish adding all subsystem message traffic to graph * reduce line spam * start work on graphing v1 types * finish graphing candidate-related structs * show hash relations, format * show provenance of ValidityAttestation * add the rest of the v1 polkadot primitives * add type diagram from polkadot::parachain::primitives * start work digramming the path to backing * diagram message flow from collation generation -> candidate selection * document flow through CandidateBacking, CandidateValidation * graph data flow through StatementDistribution * trace data flow through PoVDistribution to Backing * finish documenting node side subsystem data flow
1 parent ab606e1 commit 2dbfac3

File tree

5 files changed

+897
-0
lines changed

5 files changed

+897
-0
lines changed

roadmap/implementers-guide/book.toml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ title = "The Polkadot Parachain Host Implementers' Guide"
77

88
[preprocessor.graphviz]
99
command = "mdbook-graphviz"
10+
[preprocessor.mermaid]
11+
command = "mdbook-mermaid"
1012

1113
[output.html]
14+
additional-js = ["mermaid.min.js", "mermaid-init.js"]
15+
1216
[output.linkcheck]
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
mermaid.initialize({startOnLoad:true});

roadmap/implementers-guide/mermaid.min.js

Lines changed: 32 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)