Project ↗ | Documentation | — | Tutorials ↘ | How To's ↘ | Explanations ↘ | References ↘ |
Documentation
Users
The user documentation is mostly organized around 4 quadrants, i.e.
Studying | Working | |
---|---|---|
Practical | Tutorials (to learn from) | How To (solve problems) |
Theoretical | Explanations (for understanding) | Reference (information) |
Not all of the quadrants are filled at the moment.
The only quadrant actually ensured to contain documents at the moment is the reference information, as that part is generated from the operator specifications.
Developers
The documentation explaining the internals is directed at developers wishing to understand the package's internals, whether just for curiosity, or to extend or modify it.