Use when asked to document Elixir code: add or fill in @moduledoc and @doc for modules and functions. Documents tested code only; may add a README section or ADR. Not for docs lookup or audits.
The English summary is being prepared. Showing the original description.
See how to installReview the instructions the agent will receive before you install.
Generate documentation for newly implemented features.
/phx:document .claude/plans/magic-link-auth/plan.md
/phx:document magic link authentication
/phx:document # Auto-detect from recent plan
| Output | Description |
|---|---|
@moduledoc | For new modules missing documentation |
@doc | For public functions without docs |
| README section | For user-facing features |
| ADR | For significant architectural decisions |
Run git diff --name-only HEAD~5 | grep '\.ex$' | head -20 to check for new .ex files.
If no new .ex files were added (only modifications), skip the full
audit and report: "No new modules — documentation coverage unchanged."
A full audit of unchanged coverage produces nothing to add.
@moduledoc, @doc).claude/plans/{slug}/reviews/{feature}-docs.md| Trigger | Create ADR |
|---|---|
| New external dependency | Yes |
| New database table | Maybe (if schema non-obvious) |
| New OTP process | Yes (explain why process needed) |
| New context | Maybe (if boundaries non-obvious) |
| New auth mechanism | Yes |
| Performance optimization | Yes |
/phx:plan → /phx:work → /phx:review
↓
/phx:document ← YOU ARE HERE (optional, suggested after review passes)
${CLAUDE_SKILL_DIR}/references/doc-templates.md — @moduledoc, @doc, README, ADR templates${CLAUDE_SKILL_DIR}/references/output-format.md — Documentation report format${CLAUDE_SKILL_DIR}/references/doc-best-practices.md — Elixir documentation best practices${CLAUDE_SKILL_DIR}/references/documentation-patterns.md — Detailed documentation patternsNo reviews yet. Tell others what you thought.
No login needed. Share how it worked for you, ask a question, or note where it did not run.
No comments yet. Be the first to write one.
Analyze a legacy app in any language before rewriting it in Elixir: inventory, features as goals, why each mechanism exists, runtime topology, external contracts. Use to start or refresh a rewrite.
The English summary is being prepared. Showing the original description.
Design the idiomatic Elixir architecture for a rewrite: set the compatibility bar (ADR-000), consult phx specialists on open questions, then build contexts, ledger and ADRs. Use after /rewrite:analyze.
The English summary is being prepared. Showing the original description.
Ash Framework — resources, actions, policies, aggregates; Use when generating resources via mix ash.codegen, editing…
The English summary is being prepared. Showing the original description.
Ash Framework — resources, actions, policies, aggregates, calculations, AshPhoenix.Form, LiveView, migrations. Use when generating resources via mix ash.codegen, editing changes, checks, types, validations, or domain code interfaces.
The English summary is being prepared. Showing the original description.
Compatibility alias for the Elixir/Phoenix plugin's LiveView assigns audit. Invoke explicitly with /lv:assigns.
The English summary is being prepared. Showing the original description.
Inspect LiveView socket assigns for memory bloat — missing temporary_assigns, unused assigns, unbounded lists needing streams, memory estimates. Use when LiveView memory grows or you need to add temporary_assigns.
The English summary is being prepared. Showing the original description.