oasisprotocol / oasisprotocol/oasis-core
Document all system parameters and their relationships
Open
Nobody has claimed this yet.
c:docs
p:1
- Dominant language
- Go
- Stars
- 369
- Forks
- 151
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 6
Description
Our system has a bunch of parameters that can be set at various levels (batch size, batch timeout, consensus round timeouts, etc.). We should have a document that describes them and their relationships.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the definitions and existing documentation for system parameters, including batch size, batch timeout, and consensus round timeouts. Inventory the parameters, describe which levels set them, and document their relationships; the work is done when readers can understand how these settings interact.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100