docs: split oversized local agent entrypoints (#643)
Co-authored-by: Codex <codex@noreply.local>
This commit is contained in:
@@ -12,7 +12,7 @@ UniDesk 是一个以主 server 为统一入口的分布式工作平台;本文
|
||||
- P0: CLI 默认输出必须优先采用类似 Kubernetes CLI 的简洁表格、短摘要和可复制的 drill-down 命令;JSON 只作为 `--json`、`--raw`、`--full` 或明确机器消费模式输出,禁止把大段 JSON 当作面向人的默认阅读界面。
|
||||
- P0: 看到高频 CLI 默认输出仍是 JSON、长对象、长数组或容易超过 YAML 配置阈值的噪声输出时,必须见到一个改一个,优先把该命令改成表格优先、可再展开的渐进式披露形态,而不是反复依赖 dump 后再人工抽取。
|
||||
- P0: 自动 dump 只作为防止终端爆炸的兜底能力;一旦某个常用命令反复触发 dump,必须把 warning 视为 CLI 可用性缺陷并改进命令自身输出,不能把 dump 文件路径变成长期交互入口。
|
||||
- P0: 读取远端 `AGENTS.md`、`CLAUDE.md` 或等价入口文档触发自动 dump 时,必须优先把该入口拆成短索引;超出的细节迁入对应 skill 或 `docs/reference/` 长期参考,并在入口、skill 和长期参考之间建立交叉引用。
|
||||
- P0: 本地或远端 `AGENTS.md`、`CLAUDE.md` 或等价入口文档超过 `10 KiB`、超过 YAML dump 阈值或触发自动 dump 时,必须优先把该入口拆成短索引;超出的细节迁入对应 skill 或 `docs/reference/` 长期参考,并在入口、skill 和长期参考之间建立交叉引用。
|
||||
|
||||
## P0 最高优先级:自有配置 YAML 优先规则
|
||||
|
||||
@@ -60,6 +60,7 @@ UniDesk 是一个以主 server 为统一入口的分布式工作平台;本文
|
||||
|
||||
- P0: 任何新增、修改或蒸馏 `docs/reference/*.md` 长期参考文档的动作,必须遵循 `docs-spec` 规范;禁止绕过 `docs-spec` 凭临时习惯改写长期参考。
|
||||
- `AGENTS.md` 只做顶级索引和一句话规则摘要;长期稳定、可复用的约束、入口、判定标准必须落到 `docs/reference/`,再由 `AGENTS.md` 提供索引。
|
||||
- 本地和远端 `AGENTS.md` 治理口径一致:只要文件体积超过 `10 KiB` 或读取时触发 dump,就继续拆分到 skill / `docs/reference/`,并在入口文件和目标文档之间补交叉引用。
|
||||
- 过程记录、一次性排障、临时结论、带日期的流水账不得直接写成长期参考;需要沉淀时必须按 `docs-spec` 先蒸馏,再写入 `docs/reference/`。
|
||||
## Critical Secretary Long-Term Reference Rule
|
||||
|
||||
|
||||
@@ -36,7 +36,7 @@ OA Event Flow 的高频 trace 统计不得把每个 `trace-stats-updated` 投影
|
||||
|
||||
所有诊断型 CLI 输出必须优先摘要化、尾部化或分页化,禁止默认倾倒大 JSON、全量日志、全量 trace 或 `.state`/`logs` 宽泛搜索结果。当前硬限额入口包括:`server logs` 默认 3000 bytes tail、`job list` 默认 50 条、`job status` 默认 12000 bytes tail、`codex task/trace/output` 默认分页与文本预览、`microservice proxy` 默认 body 预览且 `--raw` 仍受硬限额保护。确实需要完整响应时必须显式使用对应的 `--full`、`--full-text`、`--tail-bytes` 或 `--limit` 参数,并在验收记录中说明为什么需要扩大输出。
|
||||
|
||||
当远端 `AGENTS.md`、`CLAUDE.md` 或同类 agent 入口文档被读取时触发自动 dump,不能只把 dump 文件路径当成继续工作的正常入口。该现象表示入口文档已经过长,必须按 `docs-spec` 把入口文件拆成短索引:只保留 P0 规则摘要、关键命令入口和指向权威文档的链接;具体流程、背景、判定标准和长篇约束迁入对应 skill 的 `SKILL.md` 或 `docs/reference/` 长期参考。拆分后入口文档、skill 和长期参考必须互相交叉引用,避免同一规则在多个位置重复展开或产生第二真相。
|
||||
本地或远端 `AGENTS.md`、`CLAUDE.md` 或同类 agent 入口文档超过 `10 KiB`、超过 YAML dump 阈值,或被 CLI/SSH/trans 读取时触发自动 dump,不能只把 dump 文件路径当成继续工作的正常入口。该现象表示入口文档已经过长,必须按 `docs-spec` 把入口文件拆成短索引:只保留 P0 规则摘要、关键命令入口和指向权威文档的链接;具体流程、背景、判定标准和长篇约束迁入对应 skill 的 `SKILL.md` 或 `docs/reference/` 长期参考。拆分后入口文档、skill 和长期参考必须互相交叉引用,避免同一规则在多个位置重复展开或产生第二真相。
|
||||
|
||||
CLI 写 stdout/stderr 遇到下游 pipe 关闭的 `EPIPE` 必须安静退出,不能打印 Bun stack trace。常见验证命令是 `set -o pipefail; bun scripts/cli.ts server status | head -1`,应只看到第一行 JSON 而无额外错误噪声。
|
||||
|
||||
|
||||
Reference in New Issue
Block a user