Documentation Status

Last reviewed: 2026-06-22

Canonical Current Docs

Document	Status	Notes
README.md	Current	Docs repository entry point.
SUMMARY.md	Current	Markdown navigation index; VitePress navigation lives in .vitepress/config.mts.
user-guide/index.md	Current	Console user guide index covering all current product areas.
user-guide/authentication.md	Current	Login, session, and role behavior.
user-guide/dashboard.md	Current	Dashboard KPI, control-plane health, and recent alert behavior.
user-guide/nodes.md	Current	Node registration, key reset, config copy, and troubleshooting.
user-guide/l3-tunnels.md	Current	L3 point-to-point tunnel workflow and constraints.
user-guide/l4-chains.md	Current	L4 chain workflow, stages, transports, and deployment.
user-guide/node-port-management.md	Current	System listener namespace, L3/L4 service ownership, priority policy, API, DB, and troubleshooting.
user-guide/l4-upstreams.md	Current	Upstream endpoint workflow.
user-guide/tls-certificates.md	Current	Compatibility redirect page for the unified credentials workflow.
user-guide/encryption-credentials.md	Current	X25519, TLS credential, and REALITY profile workflow.
user-guide/audit-log.md	Current	Audit filters, diff viewer, and revert limitations.
user-guide/users.md	Current	User listing and creation behavior.
user-guide/settings.md	Current	Account, preferences, connection hints, and system settings.
user-guide/api-only-features.md	Current	API-only compatibility/admin features without first-class console pages.
architecture/overview.md	Current	Rebuilt from current nexus-backend, nexus-agent, and nexus-frontend layout.
architecture/runtime-config-hot-reload.md	Current	Runtime config snapshot, generation, replay, rollback, apply report, and port conflict design.
reference/api.md	Current	Rebuilt from nexus-backend/src/main.rs route registration.
reference/database.md	Current	Rebuilt from migrations 001 through 033.
reference/agent-control-protocol.md	Current	Rebuilt from secure control protobuf and agent transport code.
fake-tcp/index.md	Current	Standalone FAKE_TCP overview and section map.
fake-tcp/addresses-ports.md	Current	FAKE_TCP underlay address semantics, NAT44 source behavior, and L4 port semantics.
fake-tcp/packet-format.md	Current	FAKE_TCP payload header and outer IPv4/IPv6 packet diagrams.
fake-tcp/l4-udp.md	Current	L4 UDP over FAKE_TCP listener/upstream processing and constraints.
fake-tcp/dataplane-modes.md	Current	Auto, pure eBPF, hybrid eBPF, raw fallback, RST filter, and runtime requirements.
operations/development.md	Current	Rebuilt from current project names and compose files.
operations/frontend-development.md	Current	Frontend conventions, including the table visual rules.
zh/**	Current	Simplified Chinese documentation set with matching public navigation.

Active Roadmaps

Document	Status	Notes
roadmaps/transport-composition.md	Roadmap	Rewritten with Complete, Planned, and Deprecated states.
roadmaps/quic-reality.md	Roadmap	Updated to reflect the current Quinn-based implementation.
roadmaps/quic-reality-datagram.md	Roadmap	Updated around current QUIC DATAGRAM/L3 counters and performance work.
roadmaps/quic-l3.md	Roadmap	Updated to reflect deployed L3 control-plane and agent paths.
roadmaps/tun-io-engine.md	Roadmap	Batch-first TUN/Wintun engine, packet pool, VNET metadata, and current validation state.
roadmaps/quinn-quic-reality.md	Roadmap	Added to public roadmap navigation; crate exists in nexus-agent/crates/quinn-reality.
roadmaps/kernel-dco.md	Roadmap	Long-term planned offload vision.
roadmaps/security-hardening.md	Roadmap	SPKI pinning, removed local agent config cache, rekey behavior, Noise first-packet hardening, and REALITY rotation plan.
roadmaps/observability-matrix.md	Roadmap	Future telemetry, audit, TimeDB, node health, network performance, and SD-WAN signal plan.

Removed Legacy Docs

The archive/legacy set was deleted after its remaining facts were checked against current code and migrated into the current docs where useful.

Legacy Document	Decision	Reason
archive/legacy/api-spec.md	Deleted	Mentioned /rules, MQTT, and old service routes; current API is in reference/api.md.
archive/legacy/architecture.md	Deleted	Described MQTT, BIRD/FRR, and eBPF as current components; current architecture is REST, secure gRPC, L3/L4 chain deployment, and agent gateway/L3 runtime.
archive/legacy/database.md	Deleted	Described removed route_rules and WireGuard node fields; current schema is in reference/database.md.
archive/legacy/deployment.md	Deleted	Used old control-plane, node-agent, and localdev commands; current commands are in operations/development.md.

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.