Documentation Index¶
This directory contains detailed documentation for the aipartnerupflow project.
Documentation Structure¶
Getting Started¶
- Quick Start - 5-minute quick start guide
User Documentation¶
- Main README: See ../README.md - User guide and quick start
Guides¶
- Task Orchestration - Complete guide to task orchestration, dependencies, and priorities
- Custom Tasks - Guide to creating custom tasks with ExecutableTask interface
- CLI - Complete CLI usage guide
- API Server - API server setup and usage guide
API Reference¶
- Python API - Core Python library API reference (TaskManager, ExecutableTask, TaskTreeNode, etc.)
- HTTP API - A2A Protocol Server HTTP API reference
Architecture & Design¶
- Architecture Overview - System architecture and design principles
- Directory Structure - Directory structure and naming conventions
- Naming Convention - Naming conventions for extensions
- Extension Registry Design - Extension registry design (Protocol-based architecture)
Development¶
- Setup - Development guide for contributors
- Extending - Guide for extending the framework (custom executors, extensions, hooks)
- Contributing - Contribution guidelines and process
- Design Documents - Design documents for specific features
Examples¶
- Basic Task - Basic task examples and common patterns
- Task Tree - Task tree examples with dependencies and priorities
Architecture¶
- Directory Structure - Directory structure and naming conventions
- Naming Convention - Naming conventions for extensions
- Extension Registry Design - Extension registry design (Protocol-based architecture)
- Configuration - Database table configuration
Quick Links¶
- Getting Started: quick-start.md or README.md
- Task Orchestration: guides/task-orchestration.md
- Custom Tasks: guides/custom-tasks.md
- Python API Reference: api/python.md
- HTTP API Reference: api/http.md
- Architecture Overview: architecture/overview.md
- Development Setup: development/setup.md
- Extending the Framework: development/extending.md
- Examples: examples/basic_task.md