IntersectMBO / IntersectMBO/ouroboros-consensus

Some general Consensus Layer architectural documentation

Open
#394 1 comment 0 reactions 1 assignee Claimed by @nfrisby View on GitHub
documentation
Dominant language
Haskell
Stars
67
Forks
43
Avg merge
5d 13h
Merged PRs (30d)
43

Description

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".

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.