Elixir Docs Review

Organization

existential-birds

elixir-docs-review

Reviews Elixir documentation for completeness, quality, and ExDoc best practices. Use when auditing @moduledoc, @doc, @spec coverage, doctest correctness, and cross-reference usage in .ex files.

Overview

Publisher	existential-birds
Repository	`beagle`
Skill name	`elixir-docs-review`
Stars	82
Forks	8
Bundled files	2
License	Apache-2.0
Links	Skill source Repository Homepage

Markdown instructions
A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.
Works with any LLM
AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.
2 bundled files
Scripts, templates, and references the model can read while it works. Files are read-only and never executed.
Open source
Published by existential-birds on GitHub. Read the source before you install it.

Installation

Install the Elixir Docs Review AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

Open the app and go to Plugins → Skills.
Choose "Install from GitHub".
Paste the skill folder URL below and confirm.
Enable the skill in any chat where you want it available.

Store

Installed

Skills

Add skills

Import one or more skills from a public GitHub folder or a local .skill or .zip archive, or SKILL.md file.

From GitHub URLFrom .skill, .zip, or SKILL.md

GitHub repo or folder

https://github.com/existential-birds/beagle/tree/main/plugins/beagle-elixir/skills/elixir-docs-review

Points to a single skill folder, or any folder that contains multiple skills. Public repos only.

CancelContinue

Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills

git clone --depth 1 https://github.com/existential-birds/beagle.git /tmp/beagle
mkdir -p .claude/skills
cp -r /tmp/beagle/plugins/beagle-elixir/skills/elixir-docs-review .claude/skills/elixir-docs-review

Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Elixir Docs Review in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Elixir Docs Review on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Elixir Docs Review is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

Loaded only when it is needed
The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.
Switch models mid-chat
Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

Elixir Documentation Review

Quick Reference

Issue Type	Reference
@moduledoc, @doc quality, anti-patterns	references/doc-quality.md
@spec, @type, @typedoc coverage	references/spec-coverage.md

Review Checklist

Module Documentation

All public modules have @moduledoc
First-line summary is concise (one line, used by tools as summary)
@moduledoc includes ## Examples where appropriate
@moduledoc false only on internal/implementation modules

Function Documentation

All public functions have @doc
All public functions have @spec
@doc describes return values clearly
Multi-clause functions documented before first clause
Function head declared when arg names need clarification

Doctests

Doctests present for pure, deterministic functions
No doctests for side-effectful operations (DB, HTTP, etc.)
Doctests actually run (module included in test file)

Cross-References

Module references use backtick auto-linking (MyModule)
Function refs use proper arity format (function/2)
Type refs use t: prefix (t:typename/0)
No plain-text references where auto-links are possible

Metadata

@since annotations on new public API additions
@deprecated with migration guidance where appropriate

Valid Patterns (Do NOT Flag)

@doc false on callback implementations - Documented at behaviour level
@doc false on protocol implementations - Protocol docs cover the intent
Missing @spec on private functions - @spec optional for internals
Short @moduledoc without ## Examples on simple utility modules - Not every module needs examples
Using @impl true without separate @doc - Inherits documentation from behaviour

Context-Sensitive Rules

Issue	Flag ONLY IF
Missing @moduledoc	Module is public AND not a protocol impl
Missing @spec	Function is public AND exported
Missing doctests	Function is pure AND deterministic
Generic @doc	Doc restates function name without adding value

Gates (sequenced — do not skip)

Work in order. Do not draft or ship a finding until the prior step passes.

Scope lock — Pass when: You listed the exact .ex/.exs file paths (or Module names) under review; no vague “the project” scope.
Full-context read — Pass when: For each candidate issue, you read the full surrounding definition (all clauses for multi-clause functions; full @moduledoc block for module-level claims), not only a diff hunk or search snippet.
Evidence bundle — Pass when: Every draft finding uses the [FILE:LINE] ISSUE_TITLE header (line range allowed) and includes a verbatim quote or pointer to the @doc / @spec / doctest text in question. Module.function/arity may appear as supporting context but does not replace the [FILE:LINE] anchor. For “doctest fails” claims, Pass when: you cite mix test output for the relevant file or line, or the exact error string.
Protocol before report — Pass when: You loaded and followed review-verification-protocol (its Pre-Report checklist) before finalizing the issue list—not after.

When to Load References

Reviewing @moduledoc or @doc quality, seeing anti-patterns -> doc-quality.md
Reviewing @spec, @type, or @typedoc coverage -> spec-coverage.md

Bundled files

The model reads these on demand while the skill is loaded. They are exposed as readable files and are never executed.

Frequently asked questions

What does the Elixir Docs Review AI skill do?

Reviews Elixir documentation for completeness, quality, and ExDoc best practices. Use when auditing @moduledoc, @doc, @spec coverage, doctest correctness, and cross-reference usage in .ex files.

Why use Elixir Docs Review on TypingMind?

Because you install it once and use it with any model. Elixir Docs Review is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Elixir Docs Review in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/existential-birds/beagle/tree/main/plugins/beagle-elixir/skills/elixir-docs-review. TypingMind reads its SKILL.md and bundles its files and installs it as a skill you can enable per chat.

Which AI models can use Elixir Docs Review?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Elixir Docs Review?

As many as you like. As long as a model supports skills, you can use Elixir Docs Review with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Elixir Docs Review AI skill free?

Yes. It is published on GitHub by existential-birds under the Apache-2.0 license. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

View all

Docker Patterns

affaan-m

CommunityPopular

Patrones de Docker y Docker Compose para desarrollo local, seguridad de contenedores, networking, estrategias de volúmenes y orquestación de múltiples servicios.

E2e Testing

Patrones de pruebas E2E con Playwright, Page Object Model, configuración, integración CI/CD, gestión de artefactos y estrategias para pruebas inestables.

Eval Harness

Framework formal de evaluación para sesiones de Claude Code que implementa principios de desarrollo orientado a evals (EDD)

Frontend Patterns

Patrones de desarrollo frontend para React, Next.js, gestión de estado, optimización de rendimiento y buenas prácticas de UI.

Overview

Installation

Install in TypingMind

Install in another agent

Use it in TypingMind

Works with any AI model

Skill instructions

Elixir Documentation Review

Quick Reference

Review Checklist

Module Documentation

Function Documentation

Doctests

Cross-References

Metadata

Valid Patterns (Do NOT Flag)

Context-Sensitive Rules

Gates (sequenced — do not skip)

When to Load References

Bundled files

Frequently asked questions

Related AI Skills

Set up your own AI workspace now