# Documentation Index

This directory contains detailed documentation for the aipartnerupflow project.

## Documentation Structure

### Getting Started
- **[Quick Start](getting-started/quick-start.md)** - 5-minute quick start guide

### User Documentation
- **Main README**: See [../README.md](../README.md) - User guide and quick start

### Guides
- **[Task Orchestration](guides/task-orchestration.md)** - Complete guide to task orchestration, dependencies, and priorities
- **[Custom Tasks](guides/custom-tasks.md)** - Guide to creating custom tasks with ExecutableTask interface
- **[CLI](guides/cli.md)** - Complete CLI usage guide
- **[API Server](guides/api-server.md)** - API server setup and usage guide

### API Reference
- **[Python API](api/python.md)** - Core Python library API reference (TaskManager, ExecutableTask, TaskTreeNode, etc.)
- **[HTTP API](api/http.md)** - A2A Protocol Server HTTP API reference

### Architecture & Design
- **[Architecture Overview](architecture/overview.md)** - System architecture and design principles
- **[Directory Structure](architecture/directory-structure.md)** - Directory structure and naming conventions
- **[Naming Convention](architecture/naming-convention.md)** - Naming conventions for extensions
- **[Extension Registry Design](architecture/extension-registry-design.md)** - Extension registry design (Protocol-based architecture)

### Development
- **[Setup](development/setup.md)** - Development guide for contributors
- **[Extending](development/extending.md)** - Guide for extending the framework (custom executors, extensions, hooks)
- **[Contributing](development/contributing.md)** - Contribution guidelines and process
- **[Design Documents](development/design/)** - Design documents for specific features

### Examples
- **[Basic Task](examples/basic_task.md)** - Basic task examples and common patterns
- **[Task Tree](examples/task-tree.md)** - Task tree examples with dependencies and priorities

### Architecture
- **[Directory Structure](architecture/directory-structure.md)** - Directory structure and naming conventions
- **[Naming Convention](architecture/naming-convention.md)** - Naming conventions for extensions
- **[Extension Registry Design](architecture/extension-registry-design.md)** - Extension registry design (Protocol-based architecture)
- **[Configuration](architecture/configuration.md)** - Database table configuration

## Quick Links

- **Getting Started**: [quick-start.md](getting-started/quick-start.md) or [README.md](../README.md)
- **Task Orchestration**: [guides/task-orchestration.md](guides/task-orchestration.md)
- **Custom Tasks**: [guides/custom-tasks.md](guides/custom-tasks.md)
- **Python API Reference**: [api/python.md](api/python.md)
- **HTTP API Reference**: [api/http.md](api/http.md)
- **Architecture Overview**: [architecture/overview.md](architecture/overview.md)
- **Development Setup**: [development/setup.md](development/setup.md)
- **Extending the Framework**: [development/extending.md](development/extending.md)
- **Examples**: [examples/basic_task.md](examples/basic_task.md)

