Every premium and members-only resource for $9.99/month, as a no-commitment subscription. See the plans

PalateKit

Menu

Request a resource

Describe the resource you are missing in one sentence. We will email you when it is published.

0 / 280

Unlock PalateKit

Unlock everything

Plan

Paying means accepting our terms of sale.

Secure payment by Stripe. Receipts and invoices sent by email.

Welcome back

Sign in to install, download or save this resource. A free account is enough for free resources.

Auditing Elixir documentation before publishing v1.0.0

Use this resource to audit the Elixir documentation of public modules before publishing

New

  • 323 downloads
  • 201 likes
  • 242 saves

Free

Install with the CLI

In a terminal, from the folder you want:

npx --yes palatekit@latest install elixir-docs-coverage

With no option, the skill goes to ~/.agents/skills/; add --agent claude-code (or codex, cursor…) to target an agent.

First time: connect the CLI with

npx --yes palatekit@latest login

The agent goes through public modules and functions, checking the presence and quality of @moduledoc and @doc, @spec coverage and doctest correctness. It also checks cross-references and metadata. You get an audit of documentation ready to publish.

Mostly picked by

Updated November 2, 2026

Card for the “Auditing Elixir documentation before publishing” skill

Details

Generates with
Your agent's model
Licence
Apache-2.0

Similar resources

View all

What you get

  • SKILL.md: checklist for @moduledoc, @doc and doctests
  • references/: documentation quality and @spec coverage

Good fit for

  • You want to audit an Elixir library's documentation before publishing it
  • Some public modules have no @moduledoc

Not for

    Tags

    • elixir
    • documentation
    • doctest
    • spec

    About

    You say

    “Audit the documentation of the public modules in our library.”

    Card for the “Auditing Elixir documentation before publishing” skill

    Skill published by existential-birds under the Apache-2.0 license, delivered in its original version.

    Show more

    How to use it

    1. Install the skill in your agent's skills folder
    2. Ask your agent to audit the Elixir documentation of public modules before publishing
    3. Review and adjust the result

    Content preview

    Files

    • LICENSE10.7 KB
    • NOTICE-PALATEKIT.md0.5 KB
    • references/doc-quality.md6 KB
    • references/spec-coverage.md6.9 KB
    • SKILL.md3.8 KB

    Origin and licence

    Listed unmodified

    Author
    existential-birds
    Source
    github.com/existential-birds/beagle/tree/d1a74899fbfec74974d1818e4cac7c3d54d44b65/plugins/beagle-elixir/skills/elixir-docs-review
    Licence
    Apache-2.0

    Notice

    « elixir-docs-review » (existential-birds, Apache-2.0) livré dans sa version d'origine : fiche en français et en anglais par PalateKit.

    User reviews

    –

    No ratings yet

    Loading reviews…

    Delete your review?

    Your rating and comment will be removed from the page.