How to use the farming module documentation.
In farming module, we use the Grand Unified Theory of Documentation (David Laing) as described by Divio as a basis for our documentation strategy.
This approach outlines four specific use cases for documentation:
For further background please see the ADR relating to the documentation structure.
- Write all documentation following Google Documentation Best Practice
- Generate as much documentation as possible from the code.
- Raise a PR for all documentation changes
- Follow our Code of Conduct