ChainSafe/chainbridge-core

Create overall architectural diagram and description

Closed this issue · 1 comments

P1sar commented

ChainBridge is a complex solution that consist of many parts (relayers, smart contracts, ui). We heed to have one source of information about how all of this works right now, in order to achieve this we need the architectural diagram and brief overall description about how everything works. This is gonna be useful for new developers

Implementation details

This will be a part of our chainbridge docs.
Use something like Lucidchart to draw diagrams.
Should have overall descriptions to all parts that are involved in chainbridge.
Think of it as the mai page of documentation so to say

Testing details

Acceptance Criteria

[] Graphic diagram that represents relations between all parts of chainbridge done
[] Brief overall description about how everything works overall
[] Iterate documentation over different groups of peers in order to collect feedback