-
Notifications
You must be signed in to change notification settings - Fork 33
Closed
Labels
core starter taskGood for newcomers, but aimed at core team members though still open for everyoneGood for newcomers, but aimed at core team members though still open for everyonedocumentationImprovements or additions to documentationImprovements or additions to documentation
Milestone
Description
Objective
Document Consensus module background, origin document, usage, how to build, how to use, code organization, and any other internals with README.md
Origin Document
This is a standard for all pocket modules in the repository that Consensus is not excepted from.
Hint: Checkout the README.md in other modules for examples.
Goals
- Better document the consensus module
Deliverable
- Add a comprehensive
README.mdto the Consensus module
General issue deliverables
- Update the appropriate CHANGELOG
- Update any relevant READMEs (local and/or global)
- Update any relevant global documentation & references
- If applicable, update the source code tree explanation
- If applicable, add or update a state, sequence or flowchart diagram using mermaid
Creator: @andrewnguyen22
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
core starter taskGood for newcomers, but aimed at core team members though still open for everyoneGood for newcomers, but aimed at core team members though still open for everyonedocumentationImprovements or additions to documentationImprovements or additions to documentation
Type
Projects
Status
Done