文档状态
最后核对：2026-06-22
当前规范文档
| 文档 | 状态 | 说明 |
|---|---|---|
README.md | Current | 英文入口。 |
zh/README.md | Current | 中文入口。 |
SUMMARY.md | Current | Markdown 导航索引；站点导航在 .vitepress/config.mts。 |
user-guide/* | Current | 当前控制台功能。 |
architecture/overview.md | Current | 按 nexus-backend、nexus-agent、nexus-frontend 核对。 |
architecture/runtime-config-hot-reload.md | Current | 运行时配置快照、代际、重放、回滚、应用回报和端口冲突设计。 |
reference/api.md | Current | 按 nexus-backend/src/main.rs 路由核对。 |
reference/database.md | Current | 按迁移 001 到 033 核对。 |
reference/agent-control-protocol.md | Current | 按 secure control protobuf 和 agent 传输代码核对。 |
fake-tcp/index.md | Current | 独立 FAKE_TCP 概览和章节地图。 |
fake-tcp/addresses-ports.md | Current | FAKE_TCP underlay 地址语义、NAT44 源地址行为和 L4 端口语义。 |
fake-tcp/packet-format.md | Current | FAKE_TCP payload header 和外层 IPv4/IPv6 封包图。 |
fake-tcp/l4-udp.md | Current | L4 UDP over FAKE_TCP listener/upstream 处理和限制。 |
fake-tcp/dataplane-modes.md | Current | Auto、纯 eBPF、混合 eBPF、raw fallback、RST filter 和运行要求。 |
operations/* | Current | 当前仓库和开发命令。 |
roadmaps/* | Roadmap | 已重写为“完成 / 规划 / 废弃”状态表。 |
roadmaps/tun-io-engine.md | Roadmap | 批处理 TUN/Wintun engine、packet pool、VNET metadata 和当前验证状态。 |
roadmaps/security-hardening.md | Roadmap | SPKI pin、已移除本地 Agent 配置 cache、rekey、Noise 首包加固和 REALITY 轮换计划。 |
roadmaps/observability-matrix.md | Roadmap | telemetry、audit、TimeDB、节点健康、网络性能和 SD-WAN 信号计划。 |
已删除 Legacy 文档
| 旧文档 | 处理 | 原因 |
|---|---|---|
archive/legacy/api-spec.md | 删除 | 包含 /rules、MQTT 和旧 API。 |
archive/legacy/architecture.md | 删除 | 把 MQTT、BIRD/FRR、eBPF 描述为当前组件。 |
archive/legacy/database.md | 删除 | 包含已删除的 route_rules 和 WireGuard 节点字段。 |
archive/legacy/deployment.md | 删除 | 使用旧 control-plane、node-agent、localdev 命令。 |
当前事实请使用用户指南、参考文档、运维文档和路线图。