kbase / dts

A data transfer service
https://kbase.github.io/dts/
MIT License
0 stars 0 forks source link

Write documentation for YAML config file #41

Closed jeff-cohere closed 6 months ago

jeff-cohere commented 7 months ago

Having an example YAML file is nice, but really we should write down all that's worth knowing about a DTS config file. Where this documentation lives depends on our approach: we could document the whole service in README.md, but we could also use a static site generator to stand up a documentation site for DTS. For example, I've used mkdocs for several projects and it's very simple and expressive.