Establishes a two-track per-integration doc structure (user-facing
under docs/integrations/, developer-facing under docs/dev/integrations/)
with templates that enforce a consistent set of sections for each
integration. Populates the new structure for the three existing
user-configured integrations (Home Assistant, ZoneMinder, HomeBox)
and updates the integration-addition guideline to require both docs
for any new integration.
User-facing changes:
- New per-integration pages with overview, prerequisites, credential
acquisition, configuration values, setup walkthrough, troubleshooting,
and known limitations. ZoneMinder's existing CORS and HTTPS/SSL
troubleshooting content migrated out of the shared Integrations.md
into its own page.
- Restructured docs/Integrations.md as a short landing page that
centralizes the conditional UI flow for enabling an integration
(different button label and location depending on whether any are
configured yet) so per-integration pages can link to it instead of
restating it.
- Conventions documented in the user-facing template: introduce
Home Information (HI) on first mention; use 'item' for HI's
representation, reserve 'entity' for upstream services that use
that term; use 'Import' (first run) and 'Refresh' (subsequent),
not 'sync', in user-facing copy.
Developer-facing changes:
- New per-integration dev docs for ZoneMinder and HomeBox; HA dev
doc expanded from a single section to all six required sections.
- Dev template explicitly directs writers to keep content
high-level and refer to the code for details; existing dev docs
follow that principle (key modules listed with one-line roles,
no method signatures or field lists duplicated).
- Weather integration doc gets a one-paragraph preface marking it
as an internal-source exception that does not follow the
per-integration template structure.
Simulator documentation:
- docs/dev/testing/test-simulator.md expanded to cover the
simulator's purpose and architecture, the URL mappings for
pointing each HI integration at the simulator, and the
seed_sim_profiles command (with a profile summary table and a
pointer to the command's docstring for the full operator
workflow).