Guide l'écriture de la documentation Elixir avec @moduledoc, @doc, @typedoc, doctests, références croisées et métadonnées. À utiliser lors de l'ajout ou de l'amélioration de la documentation dans les fichiers .ex.
Installez rapidement le skill IA elixir-writing-docs dans votre environnement de développement via la ligne de commande
Source : existential-birds/beagle.
| Doctests: syntax, gotchas, when to use | references/doctests.md | | Cross-references and linking syntax | references/cross-references.md | | Admonitions, formatting, tabs | references/admonitions-and-formatting.md |
ExDoc and tools like mix docs extract the first paragraph of @moduledoc and @doc as a summary. Keep the opening line concise and self-contained.
For @opaque types, the @typedoc is especially important because callers cannot inspect the structure.
Guide l'écriture de la documentation Elixir avec @moduledoc, @doc, @typedoc, doctests, références croisées et métadonnées. À utiliser lors de l'ajout ou de l'amélioration de la documentation dans les fichiers .ex. Source : existential-birds/beagle.
Champs et commandes stables pour les citations IA/recherche.
npx skills add https://github.com/existential-birds/beagle --skill elixir-writing-docsGuide l'écriture de la documentation Elixir avec @moduledoc, @doc, @typedoc, doctests, références croisées et métadonnées. À utiliser lors de l'ajout ou de l'amélioration de la documentation dans les fichiers .ex. Source : existential-birds/beagle.
Ouvrez votre terminal ou outil de ligne de commande (Terminal, iTerm, Windows Terminal, etc.) Copiez et exécutez cette commande : npx skills add https://github.com/existential-birds/beagle --skill elixir-writing-docs Une fois installé, le skill sera automatiquement configuré dans votre environnement de programmation IA et prêt à être utilisé dans Claude Code, Cursor ou OpenClaw
https://github.com/existential-birds/beagle