Documentation #

This documentation is organised in four parts, following Diataxis. Each part answers a different need. Pick the one that matches what you are doing right now.

Tutorials #

Start here if you are new. A tutorial is a lesson: it takes you by the hand through a sequence of steps to a working result, so you learn the shape of the project by using it. It does not stop to explain, and it does not offer choices.

How-to guides #

Recipes for getting a specific job done, for someone who already knows their way around. A how-to guide assumes competence, states the goal in its title, and gives the steps to reach it.

Reference #

Technical description of the machinery: commands, configuration keys, environment variables, service layout. Reference is for looking things up, not for learning. It is accurate, structured like the code it describes, and states facts without advising.

Explanation #

Background and discussion — why the project is built this way, what the alternatives were, and what each choice costs. Read these when you want to understand rather than to do.