团队如何一起更新架构

每个人都可以从文档站阅读背景,在团队仓库提出问题,再通过 PR 共同修改方案。文档站面向阅读;Issue 和 PR 保留讨论与审阅依据。

提出问题

页面上的“相关讨论”可查看对应页面的 Issue;“提出修改”打开带页面来源的表单。说明哪里不清楚、建议怎么改、影响哪些项目。执行任务必须设置 GitHub 原生 assignee;未明确负责人时先讨论分工。

修改与审阅

  1. 从最新 main 建立分支,阅读相关项目说明和决定。
  2. 更新源文档,明确事实、提议与待确认事项。
  3. 提交 PR,说明原因、来源、影响和公开内容范围。
  4. 在 CI 的审阅报告中打开预览及前后截图。内部资料不会进入公开预览。
  5. 相关团队审阅确认后合并,正式站随之更新。

与 Codex 协作

让 Codex 先阅读 AGENTS.md。它可以整理讨论、核对代码证据、修改文档和准备 PR;架构决定、任务负责人和发布结论需要真实依据。

可使用这样的请求:

读取整个项目背景,解释这次修改会影响哪些项目。更新对应文档,保留来源链接和未知事项,准备 PR 供团队审阅。

按 Git 增量整合指南,分析尚未处理的上游变化。先给出证据和影响,再修改必要页面。

一份信息,一个维护位置

项目背景和关系在 ByteInfra,具体研发任务在实施仓库。详细任务进度通过 Issue 和项目看板查看,文档保留里程碑和架构层面的解释。网页是源文档的展示版本。