Documentation Map
中文版本：文档地图
This handbook is being assembled incrementally. The first table lists the handbook’s own chapters; the second points to documents that still live elsewhere in the repository, so everything is reachable from a single place.
Handbook chapters
| Chapter | Contents |
|---|---|
| Overview | Project introduction, core capabilities, service model |
| Concepts & Terminology | AAA vocabulary, the authentication flow, password protocols |
| Quick Start | Install, initialize, first user, debugging |
| Vendor Integration Guide | Case studies: MikroTik, Huawei, Cisco, H3C, ZTE, iKuai, … |
| Portal / Hotspot Integration Boundary | Hard boundary: ToughRADIUS is the RADIUS AAA backend, not a hosted captive portal product |
| Scenario Cookbook | End-to-end ops scenarios (five-part): MikroTik PPPoE / Hotspot / CoA; Huawei BRAS speed tiers / line binding / CoA; H3C / ZTE / iKuai / Cisco per-vendor diffs |
| Admin UI Manual | The management console, page by page |
| Operations Guide | Configuration reference, certificates, monitoring, backup, CLI tools |
| LDAP / AD Authentication | Verify passwords against an LDAP/AD directory (PAP-family only): bind modes, TLS, security, metrics |
| FAQ | Frequently asked questions by theme |
| Protocol & RFC Reference | Protocol standards mapped to the code |
| Security Policy | Security advisories and update guidance |
| Agent Development Guide | Contributor digest of the AI-agent workflow, quality gates, and auto-delegation loop |
Repository documents
| Document | Description | Current location |
|---|---|---|
| README | Project introduction, features, and quick start | README.md |
| Agent guide | AI-agent development guide and working rules | Agent Development Guide (handbook digest) · AGENT.md (canonical) |
| Security policy | Security advisories and update guidance | Security Policy (canonical) · SECURITY.md (pointer) |
| Feature checklist | Feature scope baseline (TR-F IDs) | docs/feature-checklist.md · English |
| Roadmap | Long-term roadmap and milestones | docs/roadmap.md |
| RFC index | Protocol standards index used by the project | Protocol & RFC Reference (canonical) · docs/rfcs/README.md (raw catalog) |
Migration plan. The handbook now covers the README’s user-facing content (overview, quick start, vendor integration, admin manual, operations, FAQ); the README remains the GitHub landing page and links here. The agent guide now has a handbook digest chapter that points to the canonical
AGENT.md, which stays in the repository root because the agent tooling references it directly. The feature checklist and roadmap are living documents maintained indocs/by dedicated workflows and are linked rather than migrated.