gronod
ea91207196
Rename the repository to Gronod's Home Assistant Add-Ons (ha-gronod-addons). Root README becomes a repo-level overview; each add-on's README carries decision content and DOCS.md carries the full configuration/usage reference, matching mainline HA add-on conventions. Emby MCP conversation-agent URLs updated for the new repo hash (8e663231-emby-mcp) with a note for pre-rename c5cb4244 installs.
38 lines
1.7 KiB
Markdown
38 lines
1.7 KiB
Markdown
# Repository guidance
|
|
|
|
This is **Gronod's Home Assistant Add-Ons** — a Home Assistant add-on
|
|
repository. Each top-level directory is one add-on.
|
|
|
|
## Layout conventions
|
|
|
|
- Add-on directory names use hyphens and mirror the add-on slug:
|
|
`emby-mcp/` ↔ slug `emby_mcp`, `openai-codex-proxy/` ↔ slug
|
|
`openai_codex_proxy` (config.yaml slugs allow `[a-z0-9_]` only).
|
|
- Each add-on contains: `config.yaml`, `Dockerfile`, `README.md`, `DOCS.md`,
|
|
`CHANGELOG.md`, `icon.png`, `logo.png`; `build.yaml`/`rootfs/` as needed.
|
|
- `README.md` = decision content (what it is, features, requirements,
|
|
install summary). `DOCS.md` = installation, configuration, usage,
|
|
troubleshooting — the file shown in the add-on's Documentation tab.
|
|
- `repository.yaml` at the root defines the repo display name/URL.
|
|
|
|
## Hostname rule
|
|
|
|
Supervisor names add-ons `{sha1(repo_url)[:8]}-{slug-with-hyphens}`.
|
|
For `https://git.i3omb.com/gronod/ha-gronod-addons` the prefix is
|
|
`8e663231` (e.g. `8e663231-emby-mcp`). If the repo URL changes, the hash
|
|
changes and every `{hash}-{slug}` reference in docs must be updated.
|
|
(Pre-rename installs using `ha-emby-mcp` keep hash `c5cb4244`.)
|
|
|
|
## Verification
|
|
|
|
- emby-mcp (Go): `cd emby-mcp && go build ./... && go vet ./... && go test ./...`
|
|
(see `emby-mcp/AGENTS.md`; the `internal/mcphttp` end-to-end tests are
|
|
environment-sensitive and may time out on some machines)
|
|
- YAML files: `ruby -ryaml -e 'YAML.load_file(ARGV[0])' <file>`
|
|
- openai-codex-proxy: `node --check openai-codex-proxy/rootfs/entrypoint.js`
|
|
|
|
## Notes
|
|
|
|
- The Go module `git.i3omb.com/gronod/emby-mcp` and its container image are
|
|
published from the separate `gronod/emby-mcp` repo — do not repoint them.
|