Documentation overview

The Tango documentation is organized so that each page answers a different kind of question well.

The structure follows Django's documentation model closely because it works well for a framework with multiple layers.

Tutorials

Tutorials are for learning by doing. Read them from top to bottom and avoid skipping ahead.

Use a tutorial when you want to see how several Tango packages fit together in one application.

• Blog API tutorial
• Next.js blog tutorial

Topic guides

Topic guides explain how a subsystem works, what problems it solves, and where its boundaries are.

Use a topic guide when you already know the task you want to solve but you need a clear mental model first.

• Architecture
• Models and schema
• ORM and repositories
• Resources and viewsets
• Migrations
• Testing

How-to guides

How-to guides are task oriented. They assume you already know the broad concepts and need a direct path to one concrete outcome.

• Configure databases
• Run Tango in CI/CD
• Publish an OpenAPI document
• Generate and apply migrations
• Add filtering
• Add pagination

Reference

Reference pages answer precise questions about the public API.

• Config API
• CLI API
• OpenAPI API
• Schema API
• ORM query API
• Resources API

A good reading path for new users

If you are new to Tango, use this order:

1. Getting started
2. Installation
3. Quickstart
4. one tutorial
5. the topic guides for the packages you use
6. how-to guides when you begin changing behavior
7. reference when you need exact method names or contracts

A good reading path for maintainers

If you work on Tango itself:

1. use the contributor docs for setup and release workflow
2. use the topic guides to validate design intent
3. use the reference pages to keep exports and examples accurate
4. update tutorials whenever the preferred workflow changes