Руководства по написанию документации Elixir с использованием @moduledoc, @doc, @typedoc, доктестов, перекрестных ссылок и метаданных. Используйте при добавлении или улучшении документации в файлах .ex.
Быстро установите AI-навык elixir-writing-docs в вашу среду разработки через командную строку
Источник: 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.
Руководства по написанию документации Elixir с использованием @moduledoc, @doc, @typedoc, доктестов, перекрестных ссылок и метаданных. Используйте при добавлении или улучшении документации в файлах .ex. Источник: existential-birds/beagle.
Стабильные поля и команды для ссылок в AI/поиске.
npx skills add https://github.com/existential-birds/beagle --skill elixir-writing-docsРуководства по написанию документации Elixir с использованием @moduledoc, @doc, @typedoc, доктестов, перекрестных ссылок и метаданных. Используйте при добавлении или улучшении документации в файлах .ex. Источник: existential-birds/beagle.
Откройте терминал или инструмент командной строки (Terminal, iTerm, Windows Terminal и т.д.) Скопируйте и выполните эту команду: npx skills add https://github.com/existential-birds/beagle --skill elixir-writing-docs После установки навык будет автоматически настроен в вашей AI-среде разработки и готов к использованию в Claude Code, Cursor или OpenClaw
https://github.com/existential-birds/beagle