Welcome to the CodeFlow Engine documentation! This index helps you find the documentation you need.

• Quick Start Guide - Get running in 5 minutes
• Full Deployment Guide - Comprehensive deployment instructions
• Environment Variables Reference - All configuration options

• Quick Start (Docker) - 5-minute Docker setup

• Azure Deployment - Azure Container Apps
• Kubernetes Deployment - AKS, GKE, EKS

• Full Stack Deployment - Complete system deployment

• System Architecture - Complete system design
  • High-level architecture
  • Component interactions
  • Data flows
  • Deployment architecture
  • Technology stack

• API Documentation - Complete API reference
  • REST API endpoints
  • WebSocket API
  • Authentication
  • Rate limiting
  • Error codes
  • Request/response examples

• Testing Strategy - Testing philosophy and structure
• Coverage Guide - Measuring and improving coverage
• Coverage Improvement Plan - Plan to reach 80%+ coverage
• Integration Testing - Integration test guide
• E2E Testing - End-to-end test guide

Getting Started:

1. Quick Start Guide
2. Environment Variables
3. Architecture Overview

Development:

• Testing Strategy
• Coverage Guide
• API Documentation

Deployment:

1. Full Deployment Guide
2. Azure Deployment
3. Kubernetes Deployment
4. Full Stack Deployment

Configuration:

• Environment Variables

Getting Started:

1. CONTRIBUTING.md - Contribution guidelines
2. Testing Strategy
3. Coverage Improvement Plan

Writing Tests:

• Testing Strategy
• Integration Testing
• E2E Testing

API Reference:

1. API Documentation - Complete API reference
2. OpenAPI/Swagger - Available at /docs endpoint

Integration:

• Architecture - System design
• Full Stack Deployment

docs/
├── README.md                    # This file
├── deployment/                  # Deployment guides
│   ├── QUICK_START.md
│   ├── DEPLOYMENT_GUIDE.md
│   ├── AZURE_DEPLOYMENT.md
│   ├── KUBERNETES_DEPLOYMENT.md
│   └── ENVIRONMENT_VARIABLES.md
├── architecture/                # Architecture documentation
│   └── ARCHITECTURE.md
├── api/                         # API documentation
│   └── API.md
└── testing/                     # Testing documentation
    ├── TESTING_STRATEGY.md
    ├── COVERAGE_GUIDE.md
    ├── COVERAGE_IMPROVEMENT_PLAN.md
    ├── INTEGRATION_TESTING.md
    └── E2E_TESTING.md

...deploy CodeFlow Engine: → Start with Quick Start or Full Deployment Guide

...configure environment variables: → See Environment Variables Reference

...understand the architecture: → Read Architecture Documentation

...use the API: → See API Documentation

...write tests: → Start with Testing Strategy

...improve test coverage: → Follow Coverage Improvement Plan

...deploy to Azure: → See Azure Deployment Guide

...deploy to Kubernetes: → See Kubernetes Deployment Guide

...set up local development: → Use Quick Start with Docker Compose

• Main README: ../../README.md
• Contributing: ../../CONTRIBUTING.md
• Full Stack Guide: ../../codeflow-orchestration/docs/FULL_STACK_DEPLOYMENT.md
• GitHub Issues: codeflow-engine/issues

For questions or help:

• GitHub Issues: codeflow-engine/issues
• Documentation: This index and linked guides
• API Docs: Available at /docs endpoint when server is running

Last Updated: 2025-01-XX