Codex documentation-sync skill setup and implementation documentation audit
Compare build files, workflows, and architecture records to locate stale documentation and propose changes scoped to docs.
中文Install in Codex
Codex can read the project's README, AGENTS.md, QUALITY.md, workflows, architecture records, and build files. The example checks a documentation discrepancy with supplied evidence.
- Review `.agents/skills/documentation-sync/SKILL.md` and its requirements at the pinned GitHub commit.
- Create `.agents/skills/documentation-sync/` in your project and save the reviewed file as `.agents/skills/documentation-sync/SKILL.md`.
- Start Codex from that project's root, then type `$documentation-sync` and select the matching skill.
Example task
Invoke documentation-sync with this fictional export format audit and request a documentation change plan.
fixture `guide-audit-26` | workflow example: list supported export types
README example `format=csv` | build configuration `format=json`
quality note=verified local preview supports JSON export only | proposed scope=correct walkthrough onlyWhat to check
Flag `format=csv` in the README example as stale, cite the build configuration and verified preview, and propose `format=json`. Scope the documentation change plan to that walkthrough.
Original SKILL.md on GitHub · Updated
Frequently asked question
What should I do if I cannot verify implementation behavior?
Pause the proposed correction and record the evidence needed. Apply the project's companion governance skills if the change affects workflow or architecture rules.