cartesi / rollups

Cartesi Rollups
30 stars 12 forks source link

Write Node documentation #40

Closed gligneul closed 1 year ago

gligneul commented 1 year ago

📚 Context

It is hard to understand how the crates in the offchain directory work together to form the Node.

✔️ Solution

Write a readme file for the offchain part of the project. This file should contain the architectural diagram for the Node and explain what each service of the Node does.

Here is the current service diagram for the Node. This image also contains data-flow diagrams for the common operations in the Node.

Screenshot from 2023-05-17 17-05-33

The diagram should be committed to the repository. Ideally, it should be written as code using some tool like Mermaid.

📈 Subtasks