OceanWayOceanWay
运维与治理仓库

oceanway-docs 实施计划

OceanWay 架构、实施、进度、ADR、运行手册与证据索引仓库的实施计划

仓库:Oceanway-AI/oceanway-docs。生产站点:docs.oceanway.site。部署目标:la-vps2。

目标结果与当前基线

Docs 已具备独立 Git、Fumadocs/Next.js 文档站、多架构不可变镜像、SBOM/签名和自动部署。当前文档已经覆盖目标架构、ADR-028 至 ADR-031、Operations 设计、项目进度和本十四仓实施目录。

Docs 是共同基线与证据索引,不是运行配置、客户数据存储或实时 Issue Tracker。

文档信息架构

一级目录唯一职责
Architecture目标边界、不变量、领域 Owner 与 ADR
Implementation十四仓工作包、批次、依赖、验收和回滚
Progress当前已完成、下一阶段和 Changelog
GitHub任务、PR、CI、Release 与实时执行状态

仓库里程碑

  1. DOCS-1 已完成基础站:独立仓库、域名、CI、AMD64/ARM64 镜像、SBOM、签名和 la-vps2 自动部署。
  2. DOCS-2 已完成架构基线:平台、身份、共享内核、模型/Agent/MCP、双网关、钱包、Admin 与跨产品链路。
  3. DOCS-3 当前实施目录:一个仓库一个实施主页,增加批次、依赖矩阵和证据规范。
  4. DOCS-4 Runbook:随 B1/B2 增加部署、回滚、事件重放、Projection Rebuild、Gateway Unknown 与账务恢复手册。
  5. DOCS-5 契约生成:从固定 Contracts Release 生成 API/Event Reference,并显示来源版本和摘要。
  6. DOCS-6 生命周期治理:断链、过期状态、未决 ADR、证据引用、搜索与内容 Owner 自动检查。

每次变更门禁

  • MDX 编译、严格 UTF-8、乱码、代码围栏、JSON、内部链接、导航 meta 与路由唯一性通过。
  • TypeScript、生产构建、依赖审计、Secret 扫描、Docker Compose 和部署脚本检查通过。
  • 核心页面完成本地生产模式与线上浏览器回归,无 404、Application Error 或 Mermaid 错误。
  • 自动发布验证架构、实施、进度和当前新增关键路由。
  • 文档只把已有证据标记为已验收/已上线;目标态必须明确写“待实施”。

内容更新规则

  • 架构决定变化先新增/更新 ADR,再修改相关实施页。
  • 仓库验收后更新其实施基线、Evidence 链接、Progress Status 和 Changelog。
  • 实施页不保存临时分支、个人 Todo 或未经确认的日期;这些内容留在 GitHub。
  • 运行手册引用固定 Release/Image/Commit,不依赖其他仓库本地相对路径。
  • 公开文档不得包含 Customer/Provider Secret、内部网络凭据或客户正文。

发布与回滚

main 推送触发质量、安全、多架构构建、合并、SBOM、签名、la-vps2 部署和公网路由检查。失败时保持上一不可变镜像;回滚使用已验证 Image Digest,不在服务器手工编辑站点文件。

当前项目状态见进度页,发布证据规则见验收、发布与回滚

On this page