IntersectMBO / IntersectMBO/ouroboros-consensus

Consensus Blueprint 1.0

Open
#1,410 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Haskell
Stars
67
Forks
43
Avg merge
5d 13h
Merged PRs (30d)
43

Description

- Scan [our documentation](https://ouroboros-consensus.cardano.intersectmbo.org/) for content that could be adapted to the Cardano Blueprints.
- Explain protocol updates, which include hard-forks, eras, and intra-era hard-forks.
- Specification of CBOR and other binary formats Consensus uses.
- Explain ticking.
- Explain Genesis.
- Explain pipelining-diffusion.
- Discuss EBBs.
- Address pending comments in [cardano-blueprint/#8](https://github.com/cardano-scaling/cardano-blueprint/pull/8).
- Address remaining CDDL documentation issues ([#25](https://github.com/cardano-scaling/cardano-blueprint/issues/25))
- https://github.com/IntersectMBO/ouroboros-consensus/issues/1430
- Address any remaining TODOs.
- Ensure the document is properly cross-referenced.
- Make sure the structure is cohesive.
- Perform a thorough grammar check.

Contributor guide

Open the contributing guide

Research direction

Start by scanning the linked Ouroboros Consensus documentation and the pending cardano-blueprint pull request and issues. Identify the target Blueprint document, its remaining TODOs, CDDL concerns, and cross-reference gaps; done means the listed protocol topics are covered, comments are addressed, structure is cohesive, and grammar is checked.

Written by the indexing model from the issue text.

Assessment

Domain
blockchain, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.