Documentation Index

This directory contains comprehensive documentation for the Copilot API project and its ongoing migration to a hybrid Node.js + Rust architecture.

📋 Documentation Overview

Core Documentation

• ../README.md - Main project README with features and usage
• ../CLAUDE.md - Development guide for Claude Code integration

Migration Documentation

• MIGRATION-STATUS.md - Current migration status and progress tracking
• IMPLEMENTATION-GUIDE.md - Step-by-step implementation instructions
• ADR.md - Architecture Decision Records for technical choices
• PRD.md - Product Requirements Document for migration goals

API Documentation

• openai.md - OpenAI API compatibility details
• anthropic.md - Anthropic API compatibility details
• mapping.md - API endpoint mapping and translation

Web Dashboard

• index.html - Usage monitoring dashboard

🚀 Migration Status Summary

Current Phase: Planning Complete - Ready for Implementation

Architecture: Hybrid Node.js (API layer) + Rust (performance core)

Key Benefits:

• 50%+ latency reduction target
• 2x throughput improvement target
• 50% memory reduction target
• Zero breaking changes guarantee

📖 Quick Start for Developers

1. Understanding the Migration: Start with MIGRATION-STATUS.md
2. Implementation Work: Follow IMPLEMENTATION-GUIDE.md
3. Technical Decisions: Review ADR.md for architectural choices
4. Performance Goals: See PRD.md for detailed requirements

🔗 Related Resources

• GitHub Repository
• Claude Code Documentation
• OpenAI API Reference
• Anthropic API Reference

📝 Document Maintenance

• Migration Status: Updated weekly during active development
• Implementation Guide: Updated as implementation progresses
• ADRs: Updated when major technical decisions are made
• API Documentation: Updated when endpoints change

For questions or clarifications, refer to the specific documents or the main project repository.