Skip to content

table-of-contents.md

Latest commit

 

History

History
40 lines (26 loc) · 1.67 KB

table-of-contents.md

File metadata and controls

40 lines (26 loc) · 1.67 KB
Raw

Table of Contents

Documentation index for A Healthy DNS.

Minimum Reading Set

These documents must be read before proposing or applying changes to this repository.

Document Purpose
README.md Quick-start entrypoint: what the project is and how to run it for the first time
docs/project-brief.md Goals, non-goals, constraints, and requirements
docs/system-patterns.md Architecture patterns and conventions
docs/project-rules.md Language/tool specifics and QA commands

All Documents

Project foundation

Reference

  • docs/configuration-reference.md — Full CLI and Docker environment variable reference
  • docs/docker.md — Docker deployment guide: image details, Docker Compose, deployment patterns, container management, security hardening, and orchestration
  • docs/troubleshooting.md — Common issues, debugging, log interpretation, and operational procedures
  • docs/RFC-conformance.md — RFC conformance target, current coverage, and required changes for the Level 1 authoritative UDP subset

Agent Contract

  • AGENTS.md — Non-negotiable rules for all AI coding agents working in this repository