The extent of the current documentation is limited to the API docs, an outdated(?) README and some docstrings in code. This is very insufficient for anyone trying to come in and understand the project.
We must focus on creating a proper comprehensive developer documentation for the project, either here in a GitHub wiki or using something like ReadTheDocs.
The extent of the current documentation is limited to the API docs, an outdated(?) README and some docstrings in code. This is very insufficient for anyone trying to come in and understand the project.
We must focus on creating a proper comprehensive developer documentation for the project, either here in a GitHub wiki or using something like ReadTheDocs.