search

pragma-org / amaru

A node client for Cardano, written in Rust
25 stars 1 forks source link

Draft architecture diagrams #14

Open abailly-iohk opened 1 month ago

abailly-iohk commented 1 month ago

Having a few architecture diagrams, even as draft or sketch, in place would be quite useful to understand where we are and where we want to go. I found C4 Model have the right balance of flexibility and precision.

rolas978 commented 1 month ago

What do you use to make the diagrams? UML-specific? Would PlantUML be used in this case? I found out about it recently, and some of the charts look great. image

this is the guide: https://plantuml.com/guide

abailly-iohk commented 1 month ago

PlantUML is nice, yes. And there's support for C4 style with

!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
!https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Component.puml