Architecture Diagram

[pipermerriam]

What is wrong?

As a newcomer to the project, it's hard to understand all of the components of Trinity (and Py-EVM) and how they fit together.

How can it be fixed

Swarm has this really nice diagram

It shows:

• Overall structure with high level groupings of APIs
• Sub-components of the things in each group
• color coding to indicate stability

Having this should help onboard new contributors as well as reasoning about how we structure the client. The generated visuals would be nice assets to include in the documentation.

I think we could do this with graphviz via dotfile, making it easy to have as part of the repository (and easy to update as part of a pull request).

[mhchia]

Structure diagram discussed in Denver.

[pipermerriam]

Anyone have ideas on the right format for this to be converted to so that it's easy to edit/update? Favorite tool for working with this type of thing?

[cburgdorf]

so that it's easy to edit/update

I know it's not the answer you are looking for but creating this thing with Google Draw and just share it public would be pretty simple to edit/update (until Google shuts down Google Draw eventually :sweat_smile: )

[pipermerriam]

http://diagramo.com/ might be a good open source option

[ralexstokes]

it isn't free but you get ascii art for free: https://monodraw.helftone.com/