We believe a clear documentation is important to community building, reproducibility, and transparency in our open-source project. To make it easier to write our documentation in a consistent way, here we outline a brief vision for our documentation based heavily on a few common resources.
TODO: outline functions of the documentation based on resources
- Divio Documentation System
- PyOpenSci Documentation Guide
- Write the Docs Guide
- NumPy Documentation Article
- Write documentation in first person plural ("we"). In our open source code, tutorials and guides can be written by any developer or user, so the documentation teaches all of us how to do something with Parcels.