document SKILL.md skillA
document from oliver-kriska/claude-elixir-phoenix is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add oliver-kriska/claude-elixir-phoenix/document@git:20260929.c08ad14Pins git:20260929.c08ad14 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- oliver-kriska/claude-elixir-phoenix
- Path
plugins/elixir-phoenix/skills/document/SKILL.md- Versions recorded
- 6
- Latest version
- git:20260929.c08ad14, committed Sep 29, 2026
- First version recorded
- Apr 3, 2026
- Size
- 3,114 bytes
- Repository stars
- 572
- License
- MIT
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.
Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.
What the file says
# Document Generate documentation for newly implemented features. ## Usage ``` /phx:document .claude/plans/magic-link-auth/plan.md /phx:document magic link authentication /phx:document # Auto-detect from recent plan ``` ## Iron Laws 1. **Never remove existing documentation** — Existing docs may reflect design intent that isn't obvious from code alone; update rather than replace 2. **@moduledoc on every public module** — Undocumented modules accumulate quickly and create onboarding friction for new team members 3. **ADRs capture the "why", not the "what"** — Code shows what was built; ADRs explain why this approach was chosen over alternatives 4. **Match @doc to function's public API** — Document parameters, return values, and edge cases; callers shouldn't need to read the implementation 5. **DO NOT add @doc to untested code** — documentation implies a stable contract; document only after tests confirm the function behaves as described ## What Gets Documented | Output | Description | |--------|-------------| | `@moduledoc` | For new modules missing documentation | | `@doc` | For public functions without docs | | README section | For user-facing features | …
Read the whole file at its exact version.
How to install
mdr add oliver-kriska/claude-elixir-phoenix/document@sha256:7a6579f081d3461aThe line at the top of this page pins the label git:20260929.c08ad14, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.
[](https://markdownregistry.com/a/art_maraekjigx2s2mll)
2 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 6 versions of this file, between Apr 3, 2026 and Sep 29, 2026, about one every 36 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20260929.c08ad14 latest | 2026-09-29 | c08ad14 | 3,114 B | A | view · diff |
| git:20260725.7df3e51 | 2026-07-25 | 7df3e51 | 3,176 B | A | view · diff |
| git:20260724.918f809 | 2026-07-24 | 918f809 | 3,165 B | A | view · diff |
| git:20260703.08c6e0e | 2026-07-03 | 08c6e0e | 3,169 B | A | view · diff |
| git:20260508.b30a152 | 2026-05-08 | b30a152 | 3,167 B | A | view · diff |
| git:20260403.be7aa86 | 2026-04-03 | be7aa86 | 3,163 B | A | view |
Audit of the latest version
- pass: Frontmatter block present
- pass: Frontmatter declares a name
- pass: Frontmatter declares a description
- pass: Size between 200 bytes and 200 KB (3114 bytes)
- pass: No zero-width or bidi control characters
- pass: No instruction hidden inside an HTML comment
- pass: No link to an exfiltration or paste host
- pass: No credential-shaped string
- pass: No instruction to send local credentials anywhere
- pass: No text hidden with inline styles
- pass: No prompt-injection phrasing
- pass: No curl or wget piped into a shell
- pass: No recursive delete of root, home or parent
- pass: No instruction to read or print local credentials
- pass: No base64 blob over 200 characters
- pass: No link to a raw IP address
- pass: No script tag
Source
oliver-kriska/claude-elixir-phoenix · 572 stars · license MIT · pushed 2026-11-02 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_maraekjigx2s2mll GET https://markdownregistry.com/api/v1/resolve?ref=oliver-kriska/claude-elixir-phoenix/document GET https://markdownregistry.com/api/v1/blob/7a6579f081d3461af3fe5a2bcf727c3c7697177c9949758c930699e957895ba5
Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.
Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.
More from oliver-kriska/claude-elixir-phoenix
Every file in oliver-kriska/claude-elixir-phoenix