Codex Remix UI Module README for Popover Usage
Document a Remix UI primitive with canonical usage, public exports, and observable behavior established by its source, tests or demos.
中文Install in Codex
Open a Remix workspace in Codex and provide the UI module with nearby tests or demos.
- Review `.agents/skills/write-ui-module-readme/SKILL.md` and its requirements at the pinned GitHub commit.
- Create `.agents/skills/write-ui-module-readme/` in your project and save the reviewed file as `.agents/skills/write-ui-module-readme/SKILL.md`.
- Start Codex from that project's root, then type `$write-ui-module-readme` and select the matching skill.
Example task
Outline a README for a Remix filter popover using these verified module facts.
{"module":"popover","useCase":"filter panel","export":"popover.context","checkedBehavior":"focus returns to opener"}What to check
Use a filter panel for the usage example, describe `popover.context`, and document `focus returns to opener` in the behavior notes. Confirm the exact call shape in the module source.
Original SKILL.md on GitHub · Updated
Frequently asked question
Should I document the module's internal coordinator?
Focus on public exports and observable behavior. Include an internal coordinator only when it is part of the module's public contract.