Files
MoShiro/docs/README.md
T
justme e014a19554
ci/woodpecker/push/main-amd64-build Pipeline was successful
docs: reorganize into design, security, api, ops and dev; drop stale designs; refresh the diagrams [CI]
- Group docs by category with an index (docs/README.md); fix every link,
  code comment and the protocol conformance test that read docs/protocol.md.
- access.md and security.md rewritten to what is implemented: removed the
  unadopted member-proof chain, roles and recovery key that do not exist,
  the old implementation order and the budgets; gaps now carry a status.
- enrollment, deployment, api: the install flow is the static, hash-checked
  script with environment variables; no default admin.
- README and architecture: new topology and update-flow diagrams (operator
  passkey, CI signing, registry feed, auth and trust modules).
2026-10-08 19:37:56 +08:00

1.5 KiB

文档

按类别组织。每份文档开头写明它是已实现的说明还是设计稿;对不上代码时以代码为准。

类别 文档 内容
设计 architecture.md 架构、数据链路、安全边界、设计决策
protocol.md 线协议、方法的方向与角色
storage.md、query.md 存储;展示数据查询
measurement.md、analysis.md 采集引擎与任务模型;分析层与指标
安全 security.md 零信任:威胁模型、缺口与状态、协议卡口、监听隐身、extension
access.md 访问控制与入网信任链:能力、API key、passkey、操作员集合、属主、安装的供应链
enrollment.md 注册与身份:Agent、Probe 的接入,节点本地硬上限
接口 api.md、api-guidelines.md 端点说明;API 规范与约束
运维 deployment.md 构建、发布、CI、部署与更新、发布密钥
开发 project-layout.md、coding-style.md 仓库结构与依赖规则;代码风格

各子项目的说明在它们自己的目录里:backend、fleet、agent、probe、web。