anton-rs / op-up

Composable OP Stack Orchestration
https://stack.anton.systems
MIT License
41 stars 2 forks source link

chore(docs): Binary Documentation #22

Open refcell opened 12 months ago

refcell commented 12 months ago

Description

Following the precedent set in reth, minimal binary documentation should be done inline with extensive markdown book docs to avoid duplicate, and out-of-sync documentation.

For this issue, the opup binary readme.md file should be removed and minimal inline docs should be added to opup/src/lib.rs.

In the future, more extensive documentation will be added to documents in the docs/ mdbook.