# Documentation Sitemap

Complete map of all documentation files with descriptions.

> **Quick start?** Go to the [Documentation Index](index.md) for the main entry point with feature highlights.

## Overview

**Total Documents:** 31 files
**Total Lines:** ~15,000+
**Last Updated:** January 2026

---

## Documentation Structure

```
docs/
├── index.md                           # Main entry point
├── SITEMAP.md                         # This file
├── CHANGELOG.md                       # Version history
│
├── guides/
│   ├── getting-started/               # New user guides
│   │   ├── setup.md                   # Installation & configuration
│   │   └── learning-path.md           # Structured learning
│   │
│   ├── pipelines/                     # Pipeline guides
│   │   ├── yaml-pipelines.md          # Pipeline configuration
│   │   └── parallel-execution.md      # Speed optimization
│   │
│   ├── content-creation/              # Content generation
│   │   ├── prompting.md               # Writing prompts
│   │   ├── video-tips.md              # Video generation
│   │   └── video-analysis.md          # AI video analysis
│   │
│   ├── optimization/                  # Performance & cost
│   │   ├── cost-management.md         # Budget control
│   │   ├── performance.md             # Performance tuning
│   │   └── best-practices.md          # Recommended patterns
│   │
│   ├── support/                       # Help & troubleshooting
│   │   ├── troubleshooting.md         # Problem solving
│   │   ├── faq.md                     # Common questions
│   │   ├── testing.md                 # Testing strategies
│   │   └── security.md                # Security practices
│   │
│   └── contributing/                  # For contributors
│       ├── contributing.md            # Contribution guide
│       └── migration.md               # Version upgrades
│
├── reference/                         # Technical reference
│   ├── models.md                      # All 40+ AI models
│   ├── cli-commands.md                # CLI reference
│   ├── architecture.md                # System design
│   ├── package-structure.md           # Code organization
│   ├── provider-comparison.md         # Provider features
│   ├── error-codes.md                 # Error reference
│   └── api-quick-ref.md               # API summary
│
├── api/                               # API documentation
│   └── python-api.md                  # Python API reference
│
└── examples/                          # Example code
    ├── basic-examples.md              # Simple examples
    ├── advanced-pipelines.md          # Complex workflows
    ├── use-cases.md                   # Real-world apps
    └── integrations.md                # Framework integrations
```

---

## By Category

### Getting Started (New Users)

| File | Description | Time |
|------|-------------|------|
| [Setup Guide](guides/getting-started/setup.md) | Installation, configuration, API keys | 15 min |
| [Learning Path](guides/getting-started/learning-path.md) | Structured learning journey | varies |

### Pipelines

| File | Description | Level |
|------|-------------|-------|
| [YAML Pipelines](guides/pipelines/yaml-pipelines.md) | Create multi-step workflows | Beginner |
| [Parallel Execution](guides/pipelines/parallel-execution.md) | Speed up pipelines | Intermediate |

### Content Creation

| File | Description | Level |
|------|-------------|-------|
| [Prompting Guide](guides/content-creation/prompting.md) | Write effective prompts | Beginner |
| [Video Tips](guides/content-creation/video-tips.md) | Video generation best practices | Intermediate |
| [Video Analysis](guides/content-creation/video-analysis.md) | AI-powered video analysis | Intermediate |

### Optimization

| File | Description | Level |
|------|-------------|-------|
| [Cost Management](guides/optimization/cost-management.md) | Control spending | Beginner |
| [Performance](guides/optimization/performance.md) | Speed optimization | Advanced |
| [Best Practices](guides/optimization/best-practices.md) | Recommended patterns | Intermediate |

### Support

| File | Description | When to Use |
|------|-------------|-------------|
| [Troubleshooting](guides/support/troubleshooting.md) | Common issues | Problems |
| [FAQ](guides/support/faq.md) | Frequently asked questions | Questions |
| [Testing](guides/support/testing.md) | Testing strategies | Development |
| [Security](guides/support/security.md) | Security best practices | Production |

### Contributing

| File | Description | Audience |
|------|-------------|----------|
| [Contributing](guides/contributing/contributing.md) | How to contribute | Contributors |
| [Migration](guides/contributing/migration.md) | Upgrading versions | Upgrades |
| [Changelog](CHANGELOG.md) | Version history | Updates |

### Reference Materials

| File | Description | Use Case |
|------|-------------|----------|
| [Models Reference](reference/models.md) | All 40+ AI models | Model selection |
| [CLI Commands](reference/cli-commands.md) | Command line reference | CLI usage |
| [Error Codes](reference/error-codes.md) | Troubleshooting errors | Debugging |
| [API Quick Ref](reference/api-quick-ref.md) | API summary | Development |

### API & Architecture

| File | Description | Audience |
|------|-------------|----------|
| [Python API](api/python-api.md) | Complete Python reference | Developers |
| [Architecture](reference/architecture.md) | System design | Contributors |
| [Package Structure](reference/package-structure.md) | Code organization | Contributors |

### Examples & Use Cases

| File | Description | Complexity |
|------|-------------|------------|
| [Basic Examples](examples/basic-examples.md) | Simple examples | Simple |
| [Advanced Pipelines](examples/advanced-pipelines.md) | Complex workflows | Advanced |
| [Use Cases](examples/use-cases.md) | Real-world applications | Intermediate |
| [Integrations](examples/integrations.md) | Flask, FastAPI, Celery | Advanced |

---

## By User Type

### Content Creators

1. [Setup Guide](guides/getting-started/setup.md) - Get started fast
2. [Prompting Guide](guides/content-creation/prompting.md) - Write better prompts
3. [Video Tips](guides/content-creation/video-tips.md) - Create quality videos
4. [Basic Examples](examples/basic-examples.md) - Simple workflows
5. [API Quick Ref](reference/api-quick-ref.md) - Quick reference

### Developers

1. [Setup Guide](guides/getting-started/setup.md) - Full setup
2. [Python API](api/python-api.md) - API documentation
3. [YAML Pipelines](guides/pipelines/yaml-pipelines.md) - Configuration
4. [Integrations](examples/integrations.md) - Framework examples
5. [Testing Guide](guides/support/testing.md) - Testing patterns

### System Administrators

1. [Setup Guide](guides/getting-started/setup.md) - Environment setup
2. [Security](guides/support/security.md) - Security practices
3. [Cost Management](guides/optimization/cost-management.md) - Budget control
4. [Performance](guides/optimization/performance.md) - Optimization
5. [Troubleshooting](guides/support/troubleshooting.md) - Problem solving

### Contributors

1. [Contributing](guides/contributing/contributing.md) - How to contribute
2. [Architecture](reference/architecture.md) - System design
3. [Package Structure](reference/package-structure.md) - Code layout
4. [Testing Guide](guides/support/testing.md) - Test requirements
5. [Changelog](CHANGELOG.md) - Recent changes

---

## Quick Links

### Most Popular

- [Setup Guide](guides/getting-started/setup.md) - Get started
- [Models Reference](reference/models.md) - Available models
- [API Quick Ref](reference/api-quick-ref.md) - Quick reference
- [Troubleshooting](guides/support/troubleshooting.md) - Fix problems

### Essential Reading

- [Setup Guide](guides/getting-started/setup.md) - Installation & API keys
- [YAML Pipelines](guides/pipelines/yaml-pipelines.md) - Create workflows
- [Cost Management](guides/optimization/cost-management.md) - Control costs

### Deep Dives

- [Prompting Guide](guides/content-creation/prompting.md) - Master prompts
- [Performance](guides/optimization/performance.md) - Optimize speed
- [Advanced Pipelines](examples/advanced-pipelines.md) - Complex workflows

---

## Folder Summary

| Folder | Files | Description |
|--------|-------|-------------|
| `guides/getting-started/` | 2 | New user onboarding |
| `guides/pipelines/` | 2 | Pipeline configuration |
| `guides/content-creation/` | 3 | Content generation |
| `guides/optimization/` | 3 | Performance & cost |
| `guides/support/` | 4 | Help & troubleshooting |
| `guides/contributing/` | 2 | For contributors |
| `reference/` | 7 | Technical reference |
| `api/` | 1 | API documentation |
| `examples/` | 4 | Code examples |
| **Total** | **31** | |

---

## Version History

| Version | Date | Changes |
|---------|------|---------|
| 1.1 | Jan 2026 | Reorganized guides into subfolders |
| 1.0 | Jan 2026 | Initial documentation release |

---

[Back to Documentation Index](index.md)
