Codex 同步 Compartment 公共指南和生成式 CLI 参考
EnglishCodex 安装步骤
- 从固定 GitHub 提交复制 `.codex/skills/public-docs-maintenance/` 完整目录到项目 `.agents/skills/public-docs-maintenance/`。
- 选择 `$public-docs-maintenance`,提供已确认的行为或契约改动。
中文摘要
区分用户工作流指南与由 CLI 契约生成的参考,按实际交付的行为更新 Starlight 文档。
SKILL.md 中文导读
可复现示例
在练习分支设想一个导出命令增加输出格式选项。请指出哪些信息放生成参考,哪些需要一小段操作说明。工作步骤
- 查找负责生成参考的源文件和对应用户入口。
- 再补需要解释操作或决策的指南,并核对路径。
验收方法
新选项和参数出现在参考页,指南解释用户何时选择格式,并引用参考。
GitHub 原文 · 更新日期
适用环境
Codex、固定 Compartment 工作副本与仓库的文档构建环境。
常见问题
每个 UI 默认值变化都要写指南吗?
当变化会影响实际操作、配置或公开契约时,再更新相应文档。