README

AdBlock Compiler Documentation

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

Quick Links

• Main README - Project overview and quick start
• CHANGELOG - Version history and release notes
• Live Web UI - Try the compiler
• Live API - API endpoint

Documentation Structure

Getting Started

• Quick Start Guide - Get up and running with Docker in minutes
• API Documentation - REST API reference and examples
• API Quick Reference - Compact endpoint cheatsheet
• OpenAPI Support - OpenAPI 3.0 spec and tooling
• Streaming API - SSE and WebSocket real-time APIs
• Client Libraries - Client examples for Python, TypeScript, and Go
• Admin Dashboard - Dashboard UI documentation

Deployment

• Docker Deployment - Complete Docker guide with Kubernetes examples
• Cloudflare Containers - Deploy to Cloudflare edge network
• Cloudflare Pages - Deploy static UI to Cloudflare Pages
• Queue Support - Async compilation with Cloudflare Queues
• Queue Architecture - Queue system architecture with diagrams
• Cloudflare Workflows - Durable workflow execution

Development

• Testing Guide - How to run and write tests
• Benchmarks - Performance benchmarking guide
• Extensibility - Custom transformations and extensions
• Diagnostics - Debugging and diagnostic tools
• Architecture - Comprehensive system architecture
• Production Readiness - Production readiness assessment

Reference

• Migration Guide - Migrating from @adguard/hostlist-compiler
• Troubleshooting - Common issues and solutions
• Cloudflare D1 - D1 database integration
• Prisma Evaluation - Prisma ORM evaluation notes
• Implementation Summary - Queue implementation details

AI Assistant Guides

• AGENTS.md - Warp Agent guidance for this repository
• AI Assistant Guide - Detailed context for AI assistants

Contributing

See the main README for information on how to contribute to this project.