document-integration-docs

Generates Home Assistant integration documentation in the split-page format.

9.8k|8.5k|Updated Dec 21, 2014
One-click install
npx skills add https://github.com/home-assistant/home-assistant.io --skill document-integration-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-integration-docs
Source: https://github.com/home-assistant/home-assistant.io/tree/main/.claude/skills/document-integration-docs
Command: npx skills add https://github.com/home-assistant/home-assistant.io --skill document-integration-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Writing Home Assistant integration documentation requires matching a strict split-page template, exact Core implementation keys, and current UI wording, which is error-prone when done manually.

Core Features & Use Cases

  • Staged sub-agent workflow: Inventories Core triggers, conditions, and actions, extracts template and style rules, writes pages, then reviews and fixes issues.
  • Split-page generation: Creates or updates the integration page plus one page per trigger, condition, and action under source/_triggers, source/_conditions, and source/_actions.
  • Core-verified accuracy: Treats Home Assistant Core YAML files and frontend strings as the source of truth instead of issue text or outdated docs.
  • Use Case: Run /document-integration-docs lock to produce a compliant integration page and split pages for every lock trigger, condition, and action, with reviewed YAML examples and UI wording.

Quick Start

Ask the assistant to document the lock integration in the current split-page format using the document-integration-docs skill.

Frequently Asked Questions about document-integration-docs

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

FAQPage Schema
How do I document a Home Assistant integration in the split-page format?

Run the skill with the integration domain, for example /document-integration-docs lock. It inventories Core triggers, conditions, and actions, then creates or updates the integration page and one split page per feature following the developer examples template.

How do I write trigger, condition, and action pages for Home Assistant?

Each split page is named source/_triggers, source/_conditions, or source/_actions followed by domain.key.markdown, using exact Core keys. Pages must follow the developer examples template section-for-section with two concrete automation examples.

Does the skill verify documentation against Home Assistant Core?

Yes, Core is treated as the source of truth. The skill inspects conditions.yaml, services.yaml, triggers.yaml, strings.json, and frontend translations to verify keys, target domains, and UI labels rather than trusting issue text.

What happens if an integration has no triggers or conditions?

Categories not implemented in Core are simply not documented, and no split pages are created for them. The integration page then uses only the applicable individual include lines instead of the combined triggers_conditions_actions include.

Why must Home Assistant docs avoid Domain-prefixed action labels?

UI wording rules require dropping the domain prefix so labels match what users see, such as writing Turn on light instead of Light: Turn on light. Labels are taken from Core strings.json to stay consistent with the frontend.