anton-rs / op-up

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

chore(docs): Config Documentation #23

Open refcell opened 1 year ago

refcell commented 1 year ago

Description

Minimal documentation should be done inline with extensive markdown book docs to avoid duplicate, and out-of-sync documentation.

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

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