Agent skill

documentation-3-automated-api-documentation

Sub-skill of documentation: 3. Automated API Documentation (+2).

Stars 4
Forks 4

Install this agent skill to your Project

npx add-skill https://github.com/vamseeachanta/workspace-hub/tree/main/.claude/skills/_archive/development/documentation/documentation/3-automated-api-documentation

SKILL.md

3. Automated API Documentation (+2)

3. Automated API Documentation

python
# Generate API docs from docstrings
"""
Module description.

Example:
    >>> import mymodule
    >>> mymodule.function()
    'result'
"""

*See sub-skills for full details.*

## 4. Version Documentation


```bash
# Version docs with releases
version_docs() {
    local version="$1"

    # MkDocs with mike
    mike deploy "$version" latest -u
    mike set-default latest

    # Docusaurus
    npm run docusaurus docs:version "$version"
}

5. Link Validation

bash
# Check for broken links
check_links() {
    local docs_dir="${1:-docs}"

    # Using markdown-link-check
    find "$docs_dir" -name '*.md' -exec markdown-link-check {} \;

    # Using linkchecker on built site
    linkchecker ./site/index.html
}

Expand your agent's capabilities with these related and highly-rated skills.

Didn't find tool you were looking for?

Be as detailed as possible for better results