[Docs] Document RelayMiner architecture - Githubissues

pokt-network / poktroll

The official Shannon upgrade implementation of the Pocket Network Protocol implemented using Rollkit.dev

MIT License

15 stars 6 forks source link

[Docs] Document RelayMiner architecture #532

Closed red-0ne closed 1 month ago

red-0ne commented 1 month ago

Summary

Add RelayMiner documentation

Architecture
How to run it
Alternative setups
- 1-RelayMiner:N-Suppliers (Lean client)
- N-RelayMiners:1-Supplier (Shared KVStore, Shared SessionManager)

Issue

RelayMiner architecture is not documented and questions are being asked in the public channels because of this

Type of change

Select one or more:

[ ] New feature, functionality or library
[ ] Bug fix
[ ] Code health or cleanup
[x] Documentation
[ ] Other (specify)

Testing

Documentation changes (only if making doc changes)

[ ] make docusaurus_start; only needed if you make doc changes

Sanity Checklist

[ ] I have tested my changes using the available tooling
[ ] I have commented my code
[ ] I have performed a self-review of my own code; both comments & source code
[ ] I create and reference any new tickets, if applicable
[ ] I have left TODOs throughout the codebase, if applicable

Olshansk commented 1 month ago

@red-0ne Why did you close this out? Seems like there were some really good diagrams

red-0ne commented 1 month ago

@Olshansk , closed but not lost. Will revive to a proper documentation page, once we have network-able KVStore and lean client.

Olshansk commented 1 month ago

Left a comment in #528 to point to this.