-
Notifications
You must be signed in to change notification settings - Fork 0
README
Jayson Knight edited this page Mar 4, 2026
·
4 revisions
Welcome to the AdBlock Compiler documentation. This directory contains all the detailed documentation for the project.
- Main README - Project overview and quick start
- CHANGELOG - Version history and release notes
- Live Web UI - Try the compiler
- Live API - API endpoint
- 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
- 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
- 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
- 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
- AGENTS.md - Warp Agent guidance for this repository
- AI Assistant Guide - Detailed context for AI assistants
See the main README for information on how to contribute to this project.