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.
3.6 KiB
3.6 KiB
| name | description |
|---|---|
| infrastructure-doc-sync | Use when infra/container placement changes require synchronized AGENTS, docs, and Infra Info updates while keeping AGENTS concise, scoped, and non-runbook. |
Infrastructure Doc Sync
Keep infrastructure documentation aligned after operational changes.
Keep AGENTS.md short and task-scoped; move long runbooks to dedicated docs.
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.mdfile that affects infra context. - Any user-facing shortcut URL changed (Dashy).
Required Update Targets (As Applicable)
- Workspace infra truth:
../AGENTS.md(workspace-level host/topology source)
- Repo-scoped
AGENTS.mdfiles touched by the change:- Keep only hard constraints and applicability gates.
- Remove/move long runbooks into dedicated docs.
- Relevant repo docs:
README.mdcodex_skills/README.md(if adding/updating skills)
- Ops/runbook doc (if AGENTS runbook content is reduced):
- Example:
docs/agent_ops_baselines.md(repo-local operational baseline)
- Example:
- 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"
- Infra Info snapshot JSON:
docker_69:/home/hass/docker_files/infra_info/data/overview.json
Workflow
- Collect current runtime truth from hosts (containers, network mode, ports, and workload role).
- Update workspace
AGENTS.mdfirst for host/topology truth. - Update repo-level
AGENTS.mdwith concise, scoped constraints only. - Move long operational/runbook details out of
AGENTS.mdinto a dedicated doc when needed. - If end-user entry points changed, update Dashy shortcuts (
dashy/conf.yml) to match reality. - Update README/skill docs impacted by the change (short, factual, no drift).
- Update
overview.jsonto mirror the same outcome at a high level. - Validate:
- JSON is valid (
python -m json.toolequivalent). - Dashy
conf.ymlreferences the intended hostname(s)/ports (no stale LAN IPs unless intentionally required). - AGENTS and README statements do not conflict with runtime.
- Repo-level AGENTS do not contain long runbooks duplicated from dedicated docs.
- JSON is valid (
AGENTS Quality Rules
- Prefer short checklists over narrative paragraphs.
- Keep only non-discoverable, high-impact constraints in AGENTS.
- Add explicit applicability gates where a file has mixed-scope guidance.
- Keep specialized/deeper-scoped AGENTS concise and task-specific.
- De-duplicate repeated policy lines across global/workspace/repo scopes.
Infra Info Content Rules
- Keep
overview.jsonhigh-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").
- Whether runbook content was moved from AGENTS into a dedicated ops doc.
- Any unresolved follow-up items.