From ccb8f78fb70d89c39ba37cbafe9526c1e524c4bc Mon Sep 17 00:00:00 2001 From: Code Queue Review Date: Sat, 23 May 2026 06:09:50 +0000 Subject: [PATCH] =?UTF-8?q?docs:=20=E4=B8=AD=E6=96=87=E5=8C=96=20AGENTS=20?= =?UTF-8?q?=E9=A1=B6=E7=BA=A7=E7=B4=A2=E5=BC=95?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- AGENTS.md | 20 ++++++++++---------- docs/reference/documentation-governance.md | 1 + 2 files changed, 11 insertions(+), 10 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 77ffd7a5..0b3910db 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -1,8 +1,8 @@ -# HWLAB Agent Index +# HWLAB Agent 顶级索引 HWLAB 是硬件实验室运行面和控制面项目。本文是 agent、指挥官和 runner 进入本仓库时的顶级索引，只放入口、一句话规则和长期参考链接；细则统一维护在 `docs/reference/`。 -## Workspace +## 工作区 - Runner 和指挥常用工作区是 `/workspace/hwlab`；进入仓库先检查分支与工作树状态，详见 [docs/reference/commander-collaboration.md](docs/reference/commander-collaboration.md)。 - D601 发布/构建工作区是 `/home/ubuntu/workspace/hwlab`；不要把 runner 临时目录当作发布真相，详见 [docs/reference/deployment-publish.md](docs/reference/deployment-publish.md)。 @@ -24,10 +24,10 @@ HWLAB 是硬件实验室运行面和控制面项目。本文是 agent、指挥 - 架构和 M3 主线：[docs/reference/architecture.md](docs/reference/architecture.md) - DEV 运行态、端口、k3s 和 DB DNS 边界：[docs/reference/dev-runtime-boundary.md](docs/reference/dev-runtime-boundary.md) - 部署正规化、镜像发布、回滚和 Cloud Web 路径：[docs/reference/deployment-publish.md](docs/reference/deployment-publish.md) -- Code Agent chat readiness 与真实回复判定：[docs/reference/code-agent-chat-readiness.md](docs/reference/code-agent-chat-readiness.md) -- 指挥官协作、PR 和 runner handoff：[docs/reference/commander-collaboration.md](docs/reference/commander-collaboration.md) -- M3 闭环 rollout runbook：[docs/reference/m3-loop-rollout-runbook.md](docs/reference/m3-loop-rollout-runbook.md) -- runner issue 可见性与 prompt handoff：[docs/reference/runner-issue-visibility-handoff.md](docs/reference/runner-issue-visibility-handoff.md) +- Code Agent 对话就绪与真实回复判定：[docs/reference/code-agent-chat-readiness.md](docs/reference/code-agent-chat-readiness.md) +- 指挥官协作、PR 和 runner 交接：[docs/reference/commander-collaboration.md](docs/reference/commander-collaboration.md) +- M3 闭环发布运行手册：[docs/reference/m3-loop-rollout-runbook.md](docs/reference/m3-loop-rollout-runbook.md) +- runner issue 可见性与 prompt 交接：[docs/reference/runner-issue-visibility-handoff.md](docs/reference/runner-issue-visibility-handoff.md) ## 工作优先级 @@ -41,14 +41,14 @@ HWLAB 是硬件实验室运行面和控制面项目。本文是 agent、指挥 - 静态合同校验：`npm run validate` - Cloud Web 静态检查：`npm run web:check` - Cloud Web 构建：`npm run web:build` -- Cloud Web 只读 M3 guard：`npm run web:m3-readonly` -- DEV artifact preflight：`npm run dev-artifact:preflight` -- runner GitHub 可见性 preflight：`npm run runner:issue-visibility:preflight` +- Cloud Web M3 只读护栏：`npm run web:m3-readonly` +- DEV artifact 发布预检：`npm run dev-artifact:preflight` +- runner GitHub 可见性预检：`npm run runner:issue-visibility:preflight` - D601 k3s 只读观测：`npm run d601:k3s:readonly` ## D601 k3s 只读观测 -HWLAB DEV runtime 在 D601 原生 k3s；只读诊断或手动发布必须显式使用 `/etc/rancher/k3s/k3s.yaml`，详见 [docs/reference/dev-runtime-boundary.md](docs/reference/dev-runtime-boundary.md)。 +HWLAB DEV runtime（运行态）在 D601 原生 k3s；只读诊断或手动发布必须显式使用 `/etc/rancher/k3s/k3s.yaml`，详见 [docs/reference/dev-runtime-boundary.md](docs/reference/dev-runtime-boundary.md)。 ## 禁止误判 diff --git a/docs/reference/documentation-governance.md b/docs/reference/documentation-governance.md index a0aee3cf..6f2d2a81 100644 --- a/docs/reference/documentation-governance.md +++ b/docs/reference/documentation-governance.md @@ -9,6 +9,7 @@ - `AGENTS.md` 只作为项目级顶级索引，用于快速定位命令、入口和长期参考文档。 - 与 `AGENTS.md` 同等作用的文档，例如 `CLAUDE.md`，只保留 `@AGENTS.md` 引导，避免多套口径漂移。 - 每个命令在 `AGENTS.md` 中只保留一条主索引；参数、背景、判定标准写入链接的 reference 文档。 +- `AGENTS.md` 的主标题、章节名和列表摘要必须中文优先；`Agent`、`runner`、`Cloud Workbench`、命令和路径等可保留原文，但要放在中文语境中解释。 - 每个列表项只描述一个功能点，用一句中文概括，不在顶层展开实现细节。 - `AGENTS.md` 必须索引中文优先、用户反馈分流、PR 工作流、`#78` 上位约束和 `docs/reference/` 入口。