docs

docs

用于存放该微服务相关模块设计文档等。

目录规划

• 按主题建目录；目录随该主题第一篇文档落地时创建，不预建空目录 （与 test/e2e/ 的「目录创建时机」约定一致）。
• 单篇文档不直接放根目录（README.md 与跨主题全局说明除外），保持根目录整洁。
• 主题目录创建时确定本目录的命名模式并保持一致，例如：
  • dev/ — 本地开发/测试环境搭建，按依赖技术命名文件： postgres.md、etcd.md、redis.md、kafka.md…（与 config/app-dev-*.yaml 的各配置段一一对应）；
  • 设计文档目录 — 参照 adm/docs/ 的编号模式：01-xxx-design.md、02-xxx-design.md…。

当前结构

docs/
├── README.md        # 本文件：目录规划与索引
└── dev/             # 本地开发/测试环境搭建
    └── postgres.md  # 本地测试数据库（podman + postgres:18.6-bookworm）

面向用户的配置案例（如 admin 后台启用）统一存放于 doc/content/docs/guides/， 本目录只保留 testbed 专属的开发/测试环境说明。