Ryan Malloy 9855211cd0 URLs: github -> git.supported.systems/warehack.ing/{omni-pca,omni-pca-docs}

astro.config.mjs                                editLink baseUrl + GitHub social link
  README.md                                       all references
  src/content/docs/changelog.md                   release tag URL
  src/content/docs/reference/library-api.md      'see github' note
  src/content/docs/reference/protocol.mdx         opcodes.py source link
  src/content/docs/tutorials/dev-stack.md         git clone command
  src/content/docs/how-to/install-in-home-assistant.md  HACS custom-repo URL + manual git clone

Build: 23 pages clean.

2026-05-10 17:47:04 -06:00

1.5 KiB

Raw Blame History

hai-omni-docs

Documentation site for omni-pca — a reverse-engineered Python library and Home Assistant integration for HAI/Leviton Omni Pro II home automation panels. Built with Astro + Starlight, organised around the Diátaxis framework.

Live: https://hai-omni-pro-ii.l.warehack.ing

Local development

make install   # one-time
make dev       # http://localhost:4321 with hot reload

Production build (smoke test)

make ci        # runs `npm run build`, output in ./dist

Deploy via Caddy

The container ships its static dist/ from an inner Caddy on :80; the host's caddy-docker-proxy terminates TLS and routes the configured DOMAIN to it via the external caddy network.

cp .env.example .env   # adjust COMPOSE_PROJECT / DOMAIN as needed
make build
make up                # then tails logs

Layout

src/
  content/docs/
    index.mdx
    start/         # Overview + Quick start
    tutorials/     # Diátaxis: learning-oriented
    how-to/        # Diátaxis: task-oriented
    reference/     # Diátaxis: information-oriented (protocol, file format, API)
    explanation/   # Diátaxis: understanding-oriented (quirks, architecture, bugs)
    journey.md     # Chronological retrospective
    changelog.md
  styles/theme.css # Slate-blue + amber accent
  assets/logo.svg

Source project

Library + integration: https://git.supported.systems/warehack.ing/omni-pca

1.5 KiB Raw Blame History