This section brings together everything you need to understand, use, and operate this project.

The documentation is organized to support different stages of use, from the first contact to the operation and evolution of the system. Instead of concentrating all information in a single format, the content is divided into distinct types, each with a clear purpose.

This organization follows the Diátaxis model, which separates documentation based on the needs of the person using it.

How to navigate

In the left vertical menu or at the end of this page, the documentation is organized by technologies studied throughout the project. Each technology is structured into four main sections:

Tutorials

Tutorials are designed for the initial stage of contact with a technology. Their main goal is practical learning, guiding people through a continuous flow until they reach a working result. In this section, the focus is not exhaustive theory, but enabling the reader to learn by doing, building a solid foundation on how system components integrate in practice.

How-to guides

Unlike tutorials, how-to guides assume that the reader already has basic knowledge and is trying to achieve a goal or solve a specific problem. They are objective, procedural instructions focused on completing specific tasks, serving as a direct reference for people who already know what they need to do and are looking for technical guidance to complete the task efficiently.

Reference

The Reference section is the technical inventory of the system. It provides a precise description of parameters, configurations, behaviors, and specifications. This is static, informational content, essential when precise data and exact technical facts are needed to support operation or development.

Explanations

While the previous sections focus on execution, Explanations focus on understanding the “why.” This content explores concepts, design decisions, and system logic. Its goal is to provide the context behind technical choices made in the project, allowing a broad and structured understanding of the architecture.

How to use this documentation

Each type of content serves a different need. Instead of reading everything in sequence, it is better to go directly to the section that matches your current situation:

• If you are starting: go to Tutorials
• If you need to do something specific: go to How-to guides
• If you need technical details: check Reference
• If you want to understand the system better: read Explanations

Technologies