Codex Go SDK 文档维护与示例同步
EnglishCodex 安装步骤
- 打开 GitHub 固定提交的 `.agents/skills/docs-maintainer/SKILL.md`,核对内容与使用条件。
- 在自己的项目中创建 `.agents/skills/docs-maintainer/`,把核对后的文件保存为 `.agents/skills/docs-maintainer/SKILL.md`。
- 在该项目根目录启动 Codex,输入 `$docs-maintainer` 并选择同名技能。
中文摘要
对照实际实现和测试更新 Go SDK 的 README 或 MkDocs 页面。确认默认值、导入路径和使用示例能讲清当前行为。
SKILL.md 中文导读
可复现示例
对照源代码和现有文字,修订虚构客户端的重试说明。
{"api":"SetRetryLimit","actualDefault":0,"readmeDefault":2,"page":"setup"}工作步骤
- 先用源代码或测试确定当前接口、参数和默认值。
- 修改最相关的文档与调用示例,从相关页面核对相互引用。
验收方法
将 `setup` 页里的 `SetRetryLimit` 默认值由 2 改为 0,说明默认关闭重试。用该 API 的最小调用示例区分默认值与显式配置。
GitHub 原文 · 更新日期
适用环境
Codex 与目标 SDK 的实现或测试摘录、待修订的 README 或 MkDocs 页面。示例使用虚构 API。
常见问题
README 里的一项能力应该怎样复核?
先从公开实现和有关测试确认行为。指南里的导入、调用和默认值应与当前证据一致。