# Izri - Complete Documentation

> Comprehensive documentation for developers, contributors, and AI agents

## 📚 Documentation Structure

This documentation is organized into numbered sections for easy navigation and progressive learning. Each section builds upon the previous ones.

### Quick Links

- 🚀 **[Getting Started →](./getting-started/README.md)** - Set up and run the project
- 🏗️ **[Architecture →](./architecture/README.md)** - Understand the system design
- 💻 **[Development →](./development/README.md)** - Daily development workflows
- 🎨 **[Frontend →](./frontend/README.md)** - React Router web application
- ⚙️ **[Backend →](./backend/README.md)** - Hono + tRPC API service
- 📦 **[Packages →](./packages/README.md)** - Shared packages and services
- 🚢 **[Deployment →](./deployment/README.md)** - Docker and production setup
- ✨ **[Features →](./features/README.md)** - Feature implementation guides
- 🤝 **[Contributing →](./contributing/README.md)** - Contribution guidelines
- 📖 **[API Reference →](./api-reference/README.md)** - Complete API documentation
- 🗺️ **[Roadmap →](./roadmap/README.md)** - Project roadmap and status

---

## 📑 Full Documentation Index

### 01. Getting Started

Essential information to get the project running quickly.

- [Overview](./getting-started/README.md)
- [Quick Start](./getting-started/quick-start.md) - Get up and running in 5 minutes

### 02. Architecture

Deep dive into the system design and technical decisions.

- [Overview](./architecture/README.md)
- [System Overview](./architecture/overview.md) - High-level architecture
- [Technology Stack](./architecture/technology-stack.md) - All technologies used
- [Monorepo Structure](./architecture/monorepo-structure.md) - Repository organization
- [Data Flow](./architecture/data-flow.md) - How data moves through the system
- [Design Decisions](./architecture/design-decisions.md) - Key architectural decisions

### 03. Development

Daily development workflows and best practices.

- [Overview](./development/README.md)
- [Local Setup](./development/local-setup.md) - Detailed development environment setup
- [Testing](./development/testing.md) - Testing strategies and running tests

### 04. Frontend

React Router web application documentation.

- [Overview](./frontend/README.md)
- [Components and Forms](./frontend/components-and-forms.md) - UI components and form handling
- [Setup](./frontend/setup.md) - Frontend development setup
- [Testing](./frontend/testing-frontend.md) - Frontend testing strategies

### 05. Backend

Hono + tRPC API service documentation.

- [Overview](./backend/README.md)
- [Authentication and API](./backend/authentication-and-api.md) - Auth and API implementation
- [Setup](./backend/setup.md) - Backend development setup
- [Testing](./backend/testing-backend.md) - Backend testing strategies

### 06. Packages

Shared packages and their APIs.

- [Overview](./packages/README.md)
- [Database Package](./packages/database.md) - Drizzle ORM setup
- [Shared Package](./packages/shared.md) - Common utilities
- [tRPC Package](./packages/trpc.md) - tRPC router definitions
- [Auth Package](./packages/auth.md) - Authentication utilities
- [AI Service](./packages/ai-service.md) - Python AI service
- [Repo Analyzer](./packages/repo-analyzer.md) - Repository analysis tools

### 07. Deployment

Production deployment and infrastructure.

- [Overview](./deployment/README.md)
- [Docker Setup](./deployment/docker.md) - Docker configuration
- [Docker Compose](./deployment/docker-compose.md) - Multi-service orchestration
- [Environment Setup](./deployment/environment-setup.md) - Production configuration
- [Production Deployment](./deployment/production.md) - Deployment strategies

### 08. Features

Feature-specific implementation guides.

- [Overview](./features/README.md)
- [Project Management](./features/project-management.md) - Create and manage projects
- [Repository Analysis](./features/repository-analysis.md) - Code analysis pipeline
- [Test Generation](./features/test-generation.md) - AI-powered test generation (planned)
- [Test Execution](./features/test-execution.md) - Test runner implementation (planned)

### 09. Contributing

Guidelines for contributors.

- [Overview](./contributing/README.md)
- [Code Style](./contributing/code-style.md) - Coding standards
- [Commit Guidelines](./contributing/commit-guidelines.md) - Commit message conventions
- [Pull Requests](./contributing/pull-requests.md) - PR process and review

### 10. API Reference

Complete API documentation.

- [Overview](./api-reference/README.md)
- [tRPC Procedures](./api-reference/trpc-procedures.md) - All tRPC endpoints
- [REST Endpoints](./api-reference/rest-endpoints.md) - REST API reference
- [Webhooks](./api-reference/webhooks.md) - Webhook integrations
- [Webhook Endpoints](./api-reference/webhook-endpoints.md) - GitHub webhook procedures reference (MVP)
- [AI Service API](./api-reference/ai-service-api.md) - /suggest-tests, /provider, /health endpoints

### E2E Testing MVP

Documentation for the automated E2E testing pipeline.

- [E2E Testing Guide](./e2e-testing-guide.md) - End-to-end workflow for developers
- [Deployment & Setup](./deployment/setup-and-deployment.md) - Env vars, Docker, AI provider config
- [Troubleshooting](./troubleshooting.md) - Common issues and fixes
- [E2E Testing Architecture](./architecture/e2e-testing-architecture.md) - System diagram and component overview

### 11. Roadmap

Project planning and status.

- [Overview](./roadmap/README.md)
- [Planned Features](./roadmap/features.md) - Feature roadmap
- [Technical Improvements](./roadmap/improvements.md) - Technical enhancements
- [Development Timeline](./roadmap/timeline.md) - Project timeline and milestones

---

## 🔍 Documentation Principles

This documentation follows these principles:

### For Developers

- **Progressive Disclosure**: Start simple, go deep as needed
- **Practical Examples**: Real code snippets and use cases
- **Visual Aids**: Diagrams and illustrations where helpful
- **Up-to-Date**: Maintained alongside code changes

### For AI Agents

- **Structured Format**: Consistent markdown structure
- **Explicit Context**: Clear relationships between components
- **Comprehensive Details**: All implementation details documented
- **Machine-Readable**: Tables, lists, and code blocks

### Maintenance

- **Single Source of Truth**: No duplicate information
- **Versioned**: Updated with each major change
- **Reviewed**: Part of PR review process
- **Accessible**: Easy to find and navigate

---

## 🆘 Getting Help

- **Documentation Issues**: If you find errors or gaps, please open an issue
- **Questions**: Check existing docs first, then ask in discussions
- **Improvements**: PRs for documentation are always welcome

---

## 📝 Document Status

| Section | Status | Last Updated |
|---------|--------|--------------|
| Getting Started | ✅ Complete | 2025 |
| Architecture | ✅ Complete | 2025 |
| Development | ✅ Complete | 2025 |
| Frontend | ✅ Complete | 2025 |
| Backend | ✅ Complete | 2025 |
| Packages | ✅ Complete | 2025 |
| Deployment | ✅ Complete | 2025 |
| Features | 🚧 In Progress | 2025 |
| Contributing | ✅ Complete | 2025 |
| API Reference | ✅ Complete | 2025 |
| Roadmap | ✅ Complete | 2025 |

---

*This documentation is maintained as part of the Izri project and is continuously updated to reflect the current state of the system.*