Codex Go SDK documentation and example maintenance
Update README or MkDocs guidance after checking source and tests. Verify defaults, imports, and usage examples against implemented behavior.
中文Install in Codex
Codex with the target SDK's implementation or tests and a README or MkDocs page. The worked example uses a fictional API.
- Review `.agents/skills/docs-maintainer/SKILL.md` and its requirements at the pinned GitHub commit.
- Create `.agents/skills/docs-maintainer/` in your project and save the reviewed file as `.agents/skills/docs-maintainer/SKILL.md`.
- Start Codex from that project's root, then type `$docs-maintainer` and select the matching skill.
Example task
Compare the existing text with source evidence for a fictional retry setting.
{"api":"SetRetryLimit","actualDefault":0,"readmeDefault":2,"page":"setup"}What to check
On `setup`, change the documented `SetRetryLimit` default from 2 to 0 and say retries default to off. Use a minimal call to distinguish the default from explicit configuration.
Original SKILL.md on GitHub · Updated
Frequently asked question
How can I verify a capability listed in the README?
Check the public implementation and its relevant tests. The documented imports, calls, and defaults should match that evidence.