Diataxis documentation¶
This project uses the Diátaxis technical documentation framework. There are 4 main parts:
- Getting started (tutorials): learning-oriented
- Here you add pages that contain tutorials needed to get people up and running, for instance Getting Started.
- Concepts (explanation): understanding-oriented
- Here you add pages explaining concepts that are relevant to the domain, for instance Working with documentation.
- How-to guides: goal-oriented
- Here you add pages that contain tutorials, for instance How-to: start the local documentation server.
- Reference: information-oriented
- Here you add pages that contain reference information, for instance about Diataxis documentation.