informalsystems / informalsystems/emerald
[EPIC] Documentation
Open
documentation
- Dominant language
- Rust
- Stars
- 25
- Forks
- 9
- PR merge metrics
- No merged PRs in 30d
Description
When released the chain should have the following documentation:
Specifications and architecture
- [ ] System architecture - description of Malachite <> Reth interaction, assumptions made and constraints
- [ ] Configuration options - List of parameters tunable for both Malachite and Reth
- [ ] Sync protocol specification
- [ ] Crash recovery handling
Operations
- [ ] Clear instructions on how to deploy a local node or network
- [ ] Description of deployment parameters.
- [ ] Instructions for contract deployment, interaction with contracts
- [ ] Description of load generation.
- [ ] Benchmarking numbers and process description.
Contributor guide
Assessment
This issue has not been assessed yet.