整理中文文档结构与索引
This commit is contained in:
31
doc/gateway/网关文档索引.md
Normal file
31
doc/gateway/网关文档索引.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# 网关文档索引
|
||||
|
||||
这一组文档用于承接:
|
||||
|
||||
- 实时设备网关总体架构
|
||||
- 协议规范
|
||||
- MVP 拆分
|
||||
- 运行手册
|
||||
- Tunnel 开发说明
|
||||
|
||||
## 当前主文档
|
||||
|
||||
- [实时设备网关架构](/D:/dev/cmr-mini/doc/gateway/实时设备网关架构.md)
|
||||
说明网关的总体定位、角色分工、消息模型和演进方向。
|
||||
- [网关协议规范](/D:/dev/cmr-mini/doc/gateway/网关协议规范.md)
|
||||
说明消息结构、topic、角色和控制协议。
|
||||
- [运行手册](/D:/dev/cmr-mini/doc/gateway/实时网关运行手册.md)
|
||||
说明本地构建、运行、联调和常见排障方式。
|
||||
|
||||
## 补充文档
|
||||
|
||||
- [MVP 拆分](/D:/dev/cmr-mini/doc/gateway/网关MVP任务拆分.md)
|
||||
- [Cloudflare Tunnel 开发说明](/D:/dev/cmr-mini/doc/gateway/Cloudflare隧道开发说明.md)
|
||||
|
||||
## 推荐阅读顺序
|
||||
|
||||
1. [realtime-device-gateway-architecture.md](/D:/dev/cmr-mini/doc/gateway/实时设备网关架构.md)
|
||||
2. [gateway-protocol-spec.md](/D:/dev/cmr-mini/doc/gateway/网关协议规范.md)
|
||||
3. [realtime-gateway-runbook.md](/D:/dev/cmr-mini/doc/gateway/实时网关运行手册.md)
|
||||
4. [gateway-mvp-task-breakdown.md](/D:/dev/cmr-mini/doc/gateway/网关MVP任务拆分.md)
|
||||
|
||||
Reference in New Issue
Block a user