# AdBlock Compiler Documentation

Welcome to the AdBlock Compiler documentation. This directory contains all the detailed documentation for the project.

## Quick Links

- [Main README](../README.md) - Project overview and quick start
- [CHANGELOG](../CHANGELOG.md) - Version history and release notes
- [Live Web UI](https://adblock-compiler.jayson-knight.workers.dev/) - Try the compiler
- [Live API](https://adblock-compiler.jayson-knight.workers.dev/api) - API endpoint

## Documentation Structure

### Getting Started

- [Quick Start Guide](quick-start.md) - Get up and running with Docker in minutes
- [API Documentation](API_REFERENCE.md) - REST API reference and examples
- [API Quick Reference](QUICK_REFERENCE.md) - Compact endpoint cheatsheet
- [OpenAPI Support](OPENAPI_SUPPORT.md) - OpenAPI 3.0 spec and tooling
- [Streaming API](STREAMING_API.md) - SSE and WebSocket real-time APIs
- [Client Libraries](clients.md) - Client examples for Python, TypeScript, and Go
- [Admin Dashboard](ADMIN_DASHBOARD.md) - Dashboard UI documentation

### Deployment

- [Docker Deployment](docker.md) - Complete Docker guide with Kubernetes examples
- [Cloudflare Containers](cloudflare-containers.md) - Deploy to Cloudflare edge network
- [Cloudflare Pages](cloudflare-pages.md) - Deploy static UI to Cloudflare Pages
- [Queue Support](QUEUE_SUPPORT.md) - Async compilation with Cloudflare Queues
- [Queue Architecture](QUEUE_ARCHITECTURE.md) - Queue system architecture with diagrams
- [Cloudflare Workflows](CLOUDFLARE_WORKFLOWS.md) - Durable workflow execution

### Development

- [Testing Guide](testing.md) - How to run and write tests
- [Benchmarks](benchmarks.md) - Performance benchmarking guide
- [Extensibility](EXTENSIBILITY.md) - Custom transformations and extensions
- [Diagnostics](DIAGNOSTICS.md) - Debugging and diagnostic tools
- [Architecture](ARCHITECTURE.md) - Comprehensive system architecture
- [Production Readiness](PRODUCTION_READINESS.md) - Production readiness assessment

### Reference

- [Migration Guide](MIGRATION.md) - Migrating from @adguard/hostlist-compiler
- [Troubleshooting](TROUBLESHOOTING.md) - Common issues and solutions
- [Cloudflare D1](CLOUDFLARE_D1.md) - D1 database integration
- [Prisma Evaluation](PRISMA_EVALUATION.md) - Prisma ORM evaluation notes
- [Implementation Summary](IMPLEMENTATION_SUMMARY.md) - Queue implementation details

### AI Assistant Guides

- [AGENTS.md](AGENTS.md) - **Warp Agent guidance** for this repository
- [AI Assistant Guide](claude.md) - Detailed context for AI assistants

## Contributing

See the main [README](../README.md) for information on how to contribute to this project.