Codex Compartment Public Docs and Generated CLI Reference
Keep generated CLI reference aligned with the shipped contract. Add concise guidance when users need to make a decision or change their workflow.
中文Install in Codex
Codex, the pinned Compartment checkout, and its docs toolchain.
- Copy the pinned `.codex/skills/public-docs-maintenance/` directory into `.agents/skills/public-docs-maintenance/` in the project.
- Select `$public-docs-maintenance` and identify the confirmed workflow or contract change.
Example task
For a practice export command with a new output format, ask which facts belong in generated reference and which need a short task guide.What to check
The option appears in reference, and the guide explains when a user would choose it and links to the reference.
Original SKILL.md on GitHub · Updated
Frequently asked question
Does every UI default change require a guide?
Update public docs when the change affects a real user decision, procedure, or public contract.