Codex Document New Elixir Modules and Public Functions
Use `@moduledoc`, `@doc`, and validated examples to document a confirmed Elixir change.
中文Install in Codex
Use a local Elixir project, completed implementation, and an explicit documentation scope.
- Copy the pinned `skills/elixir-phoenix-document/` directory into `.agents/skills/elixir-phoenix-document/` in the project.
- Read `references/doc-templates.md` and the current diff in Codex, then identify new modules and public functions.
Example task
Document `Catalog.Labels` and its public `normalize/1` with a verified example showing how whitespace is trimmed.What to check
The documentation matches the actual signature and return value, and the example has traceable verification.
Original SKILL.md on GitHub · Updated
Frequently asked question
Should private helpers get @doc automatically?
Focus this workflow on new modules and public functions in scope. Use private comments according to the repository's conventions.