Skip to content

Documentation

Guide for contributing to Flux documentation.

Running Locally

# Install deps
pip install -r docs/requirements.txt

# Serve locally
mkdocs serve
# Open http://localhost:8000

File Structure

docs/
├── index.md              # Landing page
├── getting-started/      # Getting started guides
├── tutorials/            # Step-by-step tutorials
├── concepts/             # Core concepts
├── algorithms/           # Algorithm guides
├── configuration/        # Config reference
├── api/                  # API reference
├── how-to/               # Task-oriented guides
├── design/               # Design docs
└── contributing/         # This section

Writing Guidelines

Use Clear Headings

# Page Title
## Section
### Subsection

Code Examples

\`\`\`python
from flux import FluxConfig
config = FluxConfig(model_path="Qwen/Qwen3-8B")
\`\`\`

Admonitions

!!! note "Title"
    Content here

!!! warning
    Important warning

[Link text](../path/to/page.md)

See Also