exdoc-config

What This Skill Does

The exdoc-config skill is a dedicated developer-tools agent designed to streamline the documentation process for Elixir projects. It provides comprehensive automation and guidance for setting up, configuring, and maintaining the ExDoc documentation generator. The skill handles the complexities of mix.exs integration, enabling users to effortlessly generate professional API references, integration guides, cheatsheets, and livebooks from their codebase. By automating the boilerplate code required for the docs/0 function and dependency management, it ensures that your project documentation remains consistent, professional, and easy to navigate for your end-users.

Installation

To integrate this skill into your OpenClaw environment, execute the following command in your terminal: clawhub install openclaw/skills/skills/anderskev/exdoc-config Ensure that you are within an active Elixir project directory before invoking the skill, as it will need to interact with your mix.exs configuration file.

Use Cases

• Project Initialization: Quickly bootstrap ExDoc configuration for a new library, including dependency declaration and initial docs/0 function setup.
• Documentation Enrichment: Easily add secondary documentation formats such as .cheatmd (cheatsheets) or .livemd (Livebook) to an existing project.
• Configuration Refinement: Update project metadata, such as logo paths, homepage URLs, and output directories, to match updated project requirements.
• Structural Organization: Implement advanced grouping strategies for complex modules or multiple guide categories to improve documentation readability.

Example Prompts

1. "Configure my mix.exs file for ExDoc and set up the docs/0 function with the README as the main landing page."
2. "I need to organize my modules into groups in the ExDoc output; can you help me update my docs function to include the necessary groups_for_modules logic?"
3. "Please add my new guides folder, specifically 'guides/deployment.md' and 'guides/api-reference.md', to my ExDoc extras list."

Tips & Limitations

• File Paths: Always ensure that paths defined in the extras list are relative to the project root to prevent path resolution errors.
• Version Matching: Keep an eye on the source_ref option. If you are preparing for a release, ensure this points to your intended tag to provide users with accurate 'View Source' links.
• Limitations: While the skill can generate the necessary code, it cannot automatically audit existing complex documentation structures; it works best when you provide the specific configuration needs or module lists.