Skip to main content

Documentation

Welcome to our documentation! This site follows the Diataxis framework to provide clear, well-organized documentation.

Documentation Structureโ€‹

Our documentation is organized into four distinct sections:

๐Ÿ“š Tutorialsโ€‹

Learning-oriented guides that take you through a process step by step. Perfect for newcomers who want to get started.

๐Ÿ”ง How-To Guidesโ€‹

Task-oriented recipes that help you accomplish specific goals. Ideal when you know what you want to do.

๐Ÿ“– Referenceโ€‹

Information-oriented technical descriptions of the system. Essential when you need to look up specific details.

๐Ÿ’ก Explanationโ€‹

Understanding-oriented discussions that clarify and illuminate topics. Great for deepening your knowledge.

Quick Startโ€‹

New to this project? Start with our Getting Started Tutorial.

Contributingโ€‹

We welcome contributions to our documentation! Please see our Contributing Guide for details.