Files
MoShiro/docs/README.md
T
justme 4609048865
ci/woodpecker/push/web-build Pipeline was successful
ci/woodpecker/push/verify Pipeline was successful
ci/woodpecker/push/dev-image Pipeline was successful
docs: merge the API guidelines into api.md; drop the one-off trial reports; fix the node-update description (Quadlet restart vs host updater); tidy TODO [CI]
2026-10-09 22:31:11 +08:00

19 lines
1.5 KiB
Markdown

# 文档
按类别组织。每份文档开头写明它是已实现的说明还是设计稿;对不上代码时以代码为准。
| 类别 | 文档 | 内容 |
| --- | --- | --- |
| 设计 | [architecture.md](design/architecture.md) | 架构、数据链路、安全边界、设计决策 |
| | [protocol.md](design/protocol.md) | 线协议、方法的方向与角色 |
| | [storage.md](design/storage.md)、[query.md](design/query.md) | 存储;展示数据查询 |
| | [measurement.md](design/measurement.md)、[analysis.md](design/analysis.md) | 采集引擎与任务模型;分析层与指标 |
| 安全 | [security.md](security/security.md) | 零信任:威胁模型、缺口与状态、协议卡口、监听隐身、extension |
| | [access.md](security/access.md) | 访问控制与入网信任链:能力、API key、passkey、操作员集合、属主、安装的供应链 |
| | [enrollment.md](security/enrollment.md) | 注册与身份:Agent、Probe 的接入,节点本地硬上限 |
| 接口 | [api.md](api/api.md) | 端点说明;API 设计约束 |
| 运维 | [deployment.md](ops/deployment.md) | 构建、发布、CI、部署与更新、发布密钥 |
| 开发 | [project-layout.md](dev/project-layout.md)、[coding-style.md](dev/coding-style.md) | 仓库结构与依赖规则;代码风格 |
各子项目的说明在它们自己的目录里:[backend](../backend/README.md)、[fleet](../backend/fleet/README.md)、[agent](../backend/agent/README.md)、[probe](../backend/probe/README.md)、[web](../web/README.md)。