Documentation Status
Last reviewed: 2026-05-10
Canonical Current Docs
| Document | Status | Notes |
|---|---|---|
README.md | Current | Docs repository entry point. |
SUMMARY.md | Current | Navigation seed for a future docs web generator. |
architecture/overview.md | Current | Rebuilt from current nexus-backend, nexus-agent, and nexus-frontend layout. |
reference/api.md | Current | Rebuilt from nexus-backend/src/main.rs route registration. |
reference/database.md | Current | Rebuilt from migrations 001 through 014. |
reference/agent-control-protocol.md | Current | Rebuilt from common/proto/agent.proto and transport profile code. |
operations/development.md | Current | Rebuilt from current project names and compose files. |
Active Roadmaps
| Document | Status | Source |
|---|---|---|
roadmaps/transport-composition.md | Roadmap | Migrated from ../docs/transport-composition-roadmap.md. |
roadmaps/quic-reality.md | Roadmap | Migrated from ../nexus-agent/docs/quic-reality-roadmap.md. |
roadmaps/quic-reality-datagram.md | Roadmap | Migrated from ../nexus-agent/docs/quic-reality-datagram-roadmap.md. |
roadmaps/l3ptp-reality.md | Roadmap | Migrated from ../docs/l3ptp-reality-roadmap.md. |
roadmaps/quic-reality-kernel-dco.md | Roadmap | Migrated from ../docs/quic-reality-kernel-dco-roadmap.md. |
Archived Legacy Docs
| Legacy Document | Status | Why Archived |
|---|---|---|
archive/legacy/api-spec.md | Archived | Mentions /rules, omits current /api/l4-chains, /api/l4-upstreams, /api/certs, /api/enc-keys, and config push routes. |
archive/legacy/architecture.md | Archived | Describes MQTT/BIRD/FRR/eBPF as current components, while current code is centered on REST/gRPC, L4 chains, agent gateway, and QUIC REALITY work. |
archive/legacy/database.md | Archived | Describes route_rules and WireGuard node fields that were removed by later migrations; omits tunnel chains and unified encryption credentials. |
archive/legacy/deployment.md | Archived | Uses old control-plane, node-agent, and localdev paths instead of nexus-backend, nexus-agent, and current compose files. |
Not Migrated To Public Docs
| File | Decision |
|---|---|
../CLAUDE.md | Internal agent/developer instruction file; not product documentation and not suitable for public docs web. |
Migration Rule
When a document is moved here, update this status file. If the source document remains in a code repository during transition, treat this repository as the source of truth.