docs

Audits infrastructure changes and synchronizes README, AGENTS.md, and runbook documentation.

Updated Dec 22, 2024
One-click install
npx skills add https://github.com/jkrumm/homelab --skill docs-jkrumm
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs
Source: https://github.com/jkrumm/homelab/tree/main/.claude/skills/docs
Command: npx skills add https://github.com/jkrumm/homelab --skill docs-jkrumm

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Infrastructure repositories drift out of sync with their documentation whenever services, scripts, ports, or configs change. This Skill audits the actual state of a HomeLab Docker Compose setup and updates each fact in its single owning document, preventing stale or duplicated documentation. ## Core Features & Use Cases - Infrastructure Audit: Scans docker-compose.yml for new or removed services, checks the scripts/ directory, and audits config files, mount points, and uptime-kuma monitor definitions. - Single-Source Documentation Sync: Updates README.md (onboarding and service access), AGENTS.md (operating rules and quick reference), and docs/ runbooks so each fact lives in exactly one place, including Table of Contents synchronization. - Multi-Component Stack Detection: Identifies services opted out of Watchtower updates and prompts to register new stacks in the upgrade-stack skill. - Use Case: After adding a new container to docker-compose.yml and changing a port, run this Skill before committing to get a full audit report and updated service tables, cheatsheets, and behavior docs. ## Quick Start Audit the repository for infrastructure changes since the last commit and update README.md, AGENTS.md, and docs/ to match the current docker-compose.yml and scripts.

Frequently Asked Questions about docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I keep homelab documentation in sync with docker-compose changes?▼

Run a documentation audit that scans docker-compose.yml for new or removed services, then updates the owning document for each fact. README.md covers onboarding and service access, AGENTS.md holds operating rules, and docs/ contains runbooks.

What should I document after adding a new Docker service?▼

Document the service's port, URL, purpose, and access type (public, private, or internal) in the service tables. Also update quick command cheatsheets, the Table of Contents, and any monitor definitions in uptime-kuma/monitors.yaml.

How do I detect multi-component Docker stacks that need manual upgrades?▼

Look for services labeled with com.centurylinklabs.watchtower.enable set to false and group them by name prefix, such as immich_*. Each detected stack should be registered in the upgrade-stack documentation with version sources and compatibility notes.

When should I write a behavior documentation file for a script?▼

Create a docs/<script-name>-behaviors.md file for scripts with multiple failure modes, self-healing logic, or configuration that affects system behavior. Include sections for overview, health checks, failure scenarios, recovery behaviors, manual intervention, and configuration.

Does this documentation skill modify infrastructure or commit changes?▼

No, it only audits and updates documentation files. It does not execute infrastructure changes, modify scripts or configurations, or commit automatically; you review the diff and commit separately.