Documentation

User-facing documentation needs to be

started
~~included in CI~~ (handled by readthedocs.io)
included in MR checklists

For the JOSS checklist, the documentation should cover:

Satement of need (#132)
Installiation instructions (#133)
Example usage (#134)
Functionality documentation (i.e., (automated) API docs)
Testing instructions or automated tests
Community guidelines

Edited Oct 02, 2025 by Sander Rijn

To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information