Structured Documentation
Currently, the whole documentation resides in the README.md file.
This was okay as long as it was short and had only a little examples.
Documentation should be structured:
- A clear walktrough from zero to test
- Reference for all parameters
- Extra API documentation
- Example Scenarios
- Documentation of how to test and publish the code
This is much to much for a single README.md file.
The documentation could use the repository's wiki. Alternatively, tools/frameworks like Sphinx and mkdocs should be considered.
No due date
100% Completed
