Codex Lithia.js JSDoc for API Scope and Cleanup
Write code-grounded Lithia.js API comments that explain registration scope, side effects and cleanup whenever they affect the public contract.
中文Install in Codex
Open the Lithia.js workspace in Codex with the interface and related implementation. The resulting JSDoc is written in English.
- Review `.agents/skills/write-jsdoc/SKILL.md` and its requirements at the pinned GitHub commit.
- Create `.agents/skills/write-jsdoc/` in your project and save the reviewed file as `.agents/skills/write-jsdoc/SKILL.md`.
- Start Codex from that project's root, then type `$write-jsdoc` and select the matching skill.
Example task
Draft English JSDoc for a proposed API using these supplied, verified behaviors.
{"api":"registerFormatter","scope":"current app","registers":"report formatter","returns":"cleanup callback"}What to check
Start with `Registers a report formatter for the current app.` and use `@returns` to describe the `cleanup callback`.
Original SKILL.md on GitHub · Updated
Frequently asked question
Does every API need every JSDoc tag?
Use tags that clarify real behavior. Document a thrown error only where the contract supports it.