IntersectMBO / ouroboros-consensus

Implementation of a Consensus Layer for the Ouroboros family of protocols
https://ouroboros-consensus.cardano.intersectmbo.org
Apache License 2.0
28 stars 21 forks source link

Some general Consensus Layer architectural documentation #394

Open nfrisby opened 9 months ago

nfrisby commented 9 months ago

While designing/criticizing other high-level components, I think we've identified some pillars of the design.

I think a narrowly scoped document focusing on those pillars could be useful for multiple audiences. EG it could be a quick reference for the architects when trying to relate new ideas to the already-identified key concepts. EG it could help new contributors chart a path for understanding the architecture, etc.

In the Diátaxis framework, I would imagine this is at least in the "Reference" category. Specifically "quick reference for use by experts".

nfrisby commented 9 months ago

Some ideas from my notes: