mirror of
https://github.com/CCOSTAN/Home-AssistantConfig.git
synced 2026-06-29 19:25:19 -07:00
Update infrastructure documentation sync skill to include Dashy shortcut updates and refine README instructions for consistency after infra changes.
This commit is contained in:
@@ -25,7 +25,7 @@ Codex skills stored in-repo so they can be shared with the community. These are
|
||||
## Skills
|
||||
|
||||
- `homeassistant-dashboard-designer/`: Constrained, button-card-first Lovelace dashboard design system + YAML lint helper.
|
||||
- `infrastructure-doc-sync/`: Session closeout workflow to update AGENTS/README/Infra Info snapshot consistently after infra changes.
|
||||
- `infrastructure-doc-sync/`: Session closeout workflow to update AGENTS/README/Dashy shortcuts/Infra Info snapshot consistently after infra changes.
|
||||
|
||||
### Notes
|
||||
- Codex loads skills from your local Codex home. See each skill folder for install steps.
|
||||
|
||||
@@ -13,6 +13,7 @@ Keep infrastructure documentation aligned after operational changes.
|
||||
- Network mode/port mapping changed.
|
||||
- Host role changed (core, camera, edge, backup, etc.).
|
||||
- Any update to an `AGENTS.md` file that affects infra context.
|
||||
- Any user-facing shortcut URL changed (Dashy).
|
||||
|
||||
## Required Update Targets
|
||||
|
||||
@@ -20,17 +21,22 @@ Keep infrastructure documentation aligned after operational changes.
|
||||
2. Relevant repo README(s), usually:
|
||||
- `README.md`
|
||||
- `codex_skills/README.md` (if adding/updating skills)
|
||||
3. Infra Info snapshot JSON:
|
||||
3. Dashy shortcuts (if any service URL/host changed):
|
||||
- `h:\hass\docker_files\dashy/conf.yml`
|
||||
- Reload Dashy on docker_10 after edits: `ssh hass@192.168.10.10 "cd ~/docker_files && docker compose up -d dashy"`
|
||||
4. Infra Info snapshot JSON:
|
||||
- `docker_69:/home/hass/docker_files/infra_info/data/overview.json`
|
||||
|
||||
## Workflow
|
||||
|
||||
1. Collect current runtime truth from hosts (containers, network mode, ports, and workload role).
|
||||
2. Update AGENTS host maps and operational notes first.
|
||||
3. Update README sections impacted by the change (short, factual, no drift).
|
||||
4. Update `overview.json` to mirror the same outcome at a high level.
|
||||
5. Validate:
|
||||
3. If end-user entry points changed, update Dashy shortcuts (`dashy/conf.yml`) to match the new reality.
|
||||
4. Update README sections impacted by the change (short, factual, no drift).
|
||||
5. Update `overview.json` to mirror the same outcome at a high level.
|
||||
6. Validate:
|
||||
- JSON is valid (`python -m json.tool` equivalent).
|
||||
- Dashy `conf.yml` references the intended hostname(s)/ports (no stale LAN IPs unless intentionally required).
|
||||
- AGENTS and README statements do not conflict with runtime.
|
||||
|
||||
## Infra Info Content Rules
|
||||
@@ -40,11 +46,19 @@ Keep infrastructure documentation aligned after operational changes.
|
||||
- Avoid step-by-step runbooks.
|
||||
- Prefer host IDs and roles over low-level implementation detail.
|
||||
|
||||
## Dashy Content Rules
|
||||
|
||||
- Prefer stable hostnames (ex: `docker17`) over raw IPs when available.
|
||||
- Prefer Cloudflare/public URLs for internet-facing apps where appropriate.
|
||||
- Keep "Vibe Apps" grouped under the existing Dashy section unless the user asks for taxonomy changes.
|
||||
- After edits, reload only Dashy (avoid restarting other docker_10 services).
|
||||
|
||||
## Output Contract
|
||||
|
||||
Always report:
|
||||
|
||||
- What changed (files + purpose).
|
||||
- Final intended topology/placement.
|
||||
- Any Dashy shortcuts touched (or explicitly state "no Dashy updates needed").
|
||||
- Any unresolved follow-up items.
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
interface:
|
||||
display_name: "Infrastructure Doc Sync"
|
||||
short_description: "Sync AGENTS/README/overview after infra changes"
|
||||
default_prompt: "Use $infrastructure-doc-sync to update AGENTS.md, README notes, and infra_info overview.json after Docker/host topology changes."
|
||||
default_prompt: "Use $infrastructure-doc-sync to update AGENTS.md, Dashy shortcuts (if any URLs changed), README notes, and infra_info overview.json after Docker/host topology changes."
|
||||
|
||||
Reference in New Issue
Block a user