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 → - Set up and run the project
• 🏗️ Architecture → - Understand the system design
• 💻 Development → - Daily development workflows
• 🎨 Frontend → - React Router web application
• ⚙️ Backend → - Hono + tRPC API service
• 📦 Packages → - Shared packages and services
• 🚢 Deployment → - Docker and production setup
• ✨ Features → - Feature implementation guides
• 🤝 Contributing → - Contribution guidelines
• 📖 API Reference → - Complete API documentation
• 🗺️ Roadmap → - Project roadmap and status

📑 Full Documentation Index

01. Getting Started

Essential information to get the project running quickly.

• Overview
• Quick Start - Get up and running in 5 minutes

02. Architecture

Deep dive into the system design and technical decisions.

• Overview
• System Overview - High-level architecture
• Technology Stack - All technologies used
• Monorepo Structure - Repository organization
• Data Flow - How data moves through the system
• Design Decisions - Key architectural decisions

03. Development

Daily development workflows and best practices.

• Overview
• Local Setup - Detailed development environment setup
• Testing - Testing strategies and running tests

04. Frontend

React Router web application documentation.

• Overview
• Components and Forms - UI components and form handling
• Setup - Frontend development setup
• Testing - Frontend testing strategies

05. Backend

Hono + tRPC API service documentation.

• Overview
• Authentication and API - Auth and API implementation
• Setup - Backend development setup
• Testing - Backend testing strategies

06. Packages

Shared packages and their APIs.

• Overview
• Database Package - Drizzle ORM setup
• Shared Package - Common utilities
• tRPC Package - tRPC router definitions
• Auth Package - Authentication utilities
• AI Service - Python AI service
• Repo Analyzer - Repository analysis tools

07. Deployment

Production deployment and infrastructure.

• Overview
• Docker Setup - Docker configuration
• Docker Compose - Multi-service orchestration
• Environment Setup - Production configuration
• Production Deployment - Deployment strategies

08. Features

Feature-specific implementation guides.

• Overview
• Project Management - Create and manage projects
• Repository Analysis - Code analysis pipeline
• Test Generation - AI-powered test generation (planned)
• Test Execution - Test runner implementation (planned)

09. Contributing

Guidelines for contributors.

• Overview
• Code Style - Coding standards
• Commit Guidelines - Commit message conventions
• Pull Requests - PR process and review

10. API Reference

Complete API documentation.

• Overview
• tRPC Procedures - All tRPC endpoints
• REST Endpoints - REST API reference
• Webhooks - Webhook integrations
• Webhook Endpoints - GitHub webhook procedures reference (MVP)
• AI Service API - /suggest-tests, /provider, /health endpoints

E2E Testing MVP

Documentation for the automated E2E testing pipeline.

• E2E Testing Guide - End-to-end workflow for developers
• Deployment & Setup - Env vars, Docker, AI provider config
• Troubleshooting - Common issues and fixes
• E2E Testing Architecture - System diagram and component overview

11. Roadmap

Project planning and status.

• Overview
• Planned Features - Feature roadmap
• Technical Improvements - Technical enhancements
• Development Timeline - 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

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