INDEX.md
1 # Abzu Documentation Index 2 3 > **Version**: 0.6.1 | **Updated**: January 28, 2026 4 > 5 > **Canonical Source**: For the most accurate, up-to-date documentation, see the Knowledge Base: `abzu_sovereign_protocol` 6 7 This index provides navigation for all current Abzu documentation. For archived legacy documents, see [archive/README.md](archive/README.md). 8 9 --- 10 11 ## Quick Navigation 12 13 | Document | Purpose | When to Use | 14 |----------|---------|-------------| 15 | [TECHNICAL_SPECIFICATION.md](TECHNICAL_SPECIFICATION.md) | **Canonical reference** | Full system understanding | 16 | [ARCHITECTURE.md](ARCHITECTURE.md) | Architecture overview | High-level design | 17 | [WHITE_PAPER_v0.4.md](WHITE_PAPER_v0.4.md) | Strategic vision | External communication | 18 | [WIRE_PROTOCOL_API.md](WIRE_PROTOCOL_API.md) | Wire protocol details | Protocol implementation | 19 | [SDK_API_REFERENCE.md](SDK_API_REFERENCE.md) | SDK usage | Application development | 20 21 ### Agent Briefing (AI Agents Start Here) 22 23 | Document | Purpose | 24 |----------|---------| 25 | [AGENT_BRIEFING.md](AGENT_BRIEFING.md) | High-level concepts, architecture mental models, data flow | 26 | [CODEBASE_GUIDE.md](CODEBASE_GUIDE.md) | File navigation, search patterns, test locations | 27 | [COMPONENT_REFERENCE.md](COMPONENT_REFERENCE.md) | API reference for all major components | 28 29 --- 30 31 ## Documentation by Topic 32 33 ### Architecture & Design 34 35 - [ARCHITECTURE.md](ARCHITECTURE.md) — Crate structure, data flow, security hardening status 36 - [deep-dive/TECHNICAL_DEEP_DIVE.md](deep-dive/TECHNICAL_DEEP_DIVE.md) — Code-level analysis with test evidence 37 - [DHT_DESIGN_SPECIFICATION.md](DHT_DESIGN_SPECIFICATION.md) — Kademlia DHT layer design 38 39 ### Wire Protocol & Transport 40 41 - [WIRE_PROTOCOL_API.md](WIRE_PROTOCOL_API.md) — AbzuFrame types, version negotiation, serialization 42 - [NAT_TRAVERSAL_AND_PFS.md](NAT_TRAVERSAL_AND_PFS.md) — STUN, hole punching, forward secrecy 43 44 ### Security & Privacy 45 46 - [Ghost_Mode_Deep_Dive.md](Ghost_Mode_Deep_Dive.md) — Traffic analysis resistance 47 - [Ghost_Mode_Security_Audit.md](Ghost_Mode_Security_Audit.md) — Cover traffic security review 48 49 ### Trust & Groups 50 51 - [CIRCLE_TRUST_POLICIES.md](CIRCLE_TRUST_POLICIES.md) — Circle policies, trust ledger, vouch chains 52 - [FAULT_TOLERANCE_IMPLEMENTATION.md](FAULT_TOLERANCE_IMPLEMENTATION.md) — BFT, epidemic gossip 53 54 ### API & Integration 55 56 - [SDK_API_REFERENCE.md](SDK_API_REFERENCE.md) — AbzuClient, configuration, messaging 57 58 ### Audits (Archived) 59 60 - [archive/audit-2026-01/](archive/audit-2026-01/) — Jan 2026 security audit (archived) 61 - [archive/audit-2026-01/COMPLETE_AUDIT.md](archive/audit-2026-01/COMPLETE_AUDIT.md) — Full audit report 62 63 --- 64 65 ## Version History 66 67 | Version | Date | Major Changes | 68 |---------|------|---------------| 69 | 0.4.0 | Jan 27, 2026 | Security hardening complete (Phases 1-4), documentation consolidation | 70 | 0.3.1 | Jan 26, 2026 | Security audit, multi-hop routing, Ghost Mode hardening | 71 | 0.3.0 | Jan 2026 | Circles, epidemic gossip, tiered security | 72 | 0.2.0 | Jan 2026 | Initial FakeTLS, content-addressed storage | 73 74 --- 75 76 ## For Agents 77 78 If you're an AI agent working on Abzu: 79 80 1. **Start here** — This index gives you the documentation map 81 2. **Check `.context/`** — For current implementation status 82 3. **Use TECHNICAL_SPECIFICATION.md** — As the single source of truth 83 4. **Consult topic-specific docs** — For deep dives on specific areas 84 85 See [.context/README.md](.context/README.md) for agent-specific context management. 86 87 --- 88 89 ## Document Relationships 90 91 ``` 92 ┌─────────────────────────┐ 93 │ WHITE_PAPER_v0.4.md │ 94 │ (Strategic Vision) │ 95 └────────────┬────────────┘ 96 │ 97 ┌────────────▼────────────┐ 98 │ TECHNICAL_SPECIFICATION │ 99 │ (Canonical Reference) │ 100 └────────────┬────────────┘ 101 │ 102 ┌────────────────────────┼────────────────────────┐ 103 │ │ │ 104 ▼ ▼ ▼ 105 ┌───────────────┐ ┌───────────────────┐ ┌───────────────────┐ 106 │ ARCHITECTURE │ │ WIRE_PROTOCOL_API │ │ SDK_API_REFERENCE │ 107 │ (Structure) │ │ (Protocol) │ │ (Usage) │ 108 └───────┬───────┘ └─────────┬─────────┘ └───────────────────┘ 109 │ │ 110 ▼ ▼ 111 ┌───────────────────────────────────────────┐ 112 │ Topic-Specific Deep Dives │ 113 │ (Ghost Mode, NAT, Circles, Audit, etc.) │ 114 └───────────────────────────────────────────┘ 115 ```