There are a few issues with our documentation that deserve to be addressed:
- Multiple places: Markdown files, Sphinx, Go Docs
- Availability: Easy to browse Markdown on GitHub, but others docs aren't readily web accessible
- Build process: building Sphinx documentation requires dependencies and doesn't work out-of-the-box
We should revisit how we do documentation and make sure that our approach is aligned with the current project aims and needs. I'd also suggest that documentation is easy to access from a web browser. I've also started using Docker for the Sphinx builds and suggest that we do this by default.
There are a few issues with our documentation that deserve to be addressed:
We should revisit how we do documentation and make sure that our approach is aligned with the current project aims and needs. I'd also suggest that documentation is easy to access from a web browser. I've also started using Docker for the Sphinx builds and suggest that we do this by default.