[RATIS-220] Overall project design document

• Type: Sub-task
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Affects Version/s: 0.1.0-alpha
• Component/s: documentation
• Labels: documentation
• Flags: Important
• Assignee: Tsz-wo Sze
• Reporter: Vinay Banakar
• Created: 04/Apr/18 17:32
• Updated: 25/Jul/22 16:37

Description

Although the code is well documented, the project's design is nowhere to be found. Each of the listed components can have their own documentation page delineating its purpose and dependencies. Have one master design document which portrays overall system design and interaction between components.

To begin with, let's not be scrupulous about flowcharts and UML diagrams. A simple high level diagram would do.