User Guides

Step-by-step guides to help you get the most out of the Ad-Blocking Toolkit.

  • /guides/api-client-examples/

    AdGuard DNS API Client - Code Examples This document provides practical examples using the refactored helper classes. Configuration Examples Using ConfigurationHelper DateTime Helper Examples Working…

  • /guides/api-client-usage/

    AdGuard DNS API Client - Usage Guide This C# client library provides a strongly-typed interface to the AdGuard DNS API (v1.11). Overview The AdGuard DNS API Client was generated from the official…

  • /guides/consoleui-architecture/

    AdGuard ConsoleUI Architecture This document describes the architecture and design patterns used in the AdGuard.ConsoleUI application. Overview AdGuard.ConsoleUI is a menu-driven console application…

  • /guides/deployment-guide/

    Deployment Guide Comprehensive guide for deploying ad-blocking components in production environments. Overview This guide covers deployment strategies for all components in the ad-blocking repository…

  • /guides/migration-guide/

    Migration Guide Guide for migrating between different compiler implementations and SDK versions in the ad-blocking repository. Overview This guide helps you migrate between: Different rules compiler…

  • /guides/testing-guide/

    Testing Guide Comprehensive guide to running tests for all components in the ad-blocking repository. Overview This project uses different testing frameworks for each language implementation: Component…

  • /guides/troubleshooting-guide/

    Troubleshooting Guide Comprehensive guide for troubleshooting common issues across all components in the ad-blocking repository. Overview This guide provides solutions for common issues you may…

  • /guides/typescript-api-sdk/

    TypeScript API SDK Guide A comprehensive guide to using the AdGuard DNS TypeScript API SDK with Deno 2.0+. Overview The TypeScript API SDK provides a complete, type-safe interface to the AdGuard DNS…

  • /guides/typescript-rules-compiler/

    TypeScript Rules Compiler Guide A comprehensive guide to using the TypeScript rules compiler with Deno 2.0+. Overview The TypeScript rules compiler is a Deno-based implementation that wraps @adguard…