Skip to main content

How the documentation is organized

Organized documents

The documentation is inspired by Django's documentation and organized into the following types:

  • Tutorials take you by the hand through a series of steps. Start here if you’re new.
  • How-to guides are recipes. They guide you through the steps involved in addressing key problems and use cases. They are more advanced than tutorials and assume some knowledge.
  • Topic guides discuss key topics and concepts at a fairly high level and provide useful background information and explanation.
  • Reference guides contain technical reference for APIs. They describe how it works and how to use it but assume that you have a basic understanding of key concepts.

Photo by Maarten van den Heuvel on Unsplash