You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

2.6 KiB

name description
infrastructure-doc-sync Use when infra or container placement changes were made in a session and documentation must be synchronized across AGENTS.md, README(s), and Infra Info snapshot (`overview.json`). Covers host maps, role notes, and safe high-level summary updates.

Infrastructure Doc Sync

Keep infrastructure documentation aligned after operational changes.

When to Use

  • Docker service moved between hosts.
  • 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

  1. ../AGENTS.md (workspace-level infra truth in h:\hass\docker_files\AGENTS.md)
  2. Relevant repo README(s), usually:
    • README.md
    • codex_skills/README.md (if adding/updating skills)
  3. Dashy shortcuts (if any service URL/host changed):
    • h:\hass\docker_files\dashy/conf.yml
    • Reload Dashy on docker_17 after edits: ssh hass@192.168.10.17 "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. 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

  • Keep overview.json high-level and planning-focused.
  • Do not include secrets, tokens, passwords, or internal file paths.
  • 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_17 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.

Powered by TurnKey Linux.