infrastructure-doc-sync

Update AGENTS files, READMEs, and Dashy configurations after infrastructure changes.

5.3k|503|Updated Oct 11, 2016
One-click install
npx skills add https://github.com/CCOSTAN/Home-AssistantConfig --skill infrastructure-doc-sync
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: infrastructure-doc-sync
Source: https://github.com/CCOSTAN/Home-AssistantConfig/tree/main/codex_skills/infrastructure-doc-sync
Command: npx skills add https://github.com/CCOSTAN/Home-AssistantConfig --skill infrastructure-doc-sync

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes agents (resource) components.

What problem does it solve?

This Skill ensures that infrastructure documentation remains synchronized with actual operational changes, preventing documentation drift and maintaining clarity on system topology and agent configurations.

Core Features & Use Cases

  • Synchronized Documentation: Updates AGENTS.md, READMEs, and other relevant documentation after infrastructure changes (e.g., container moves, network updates).
  • Concise AGENTS Files: Keeps AGENTS.md focused on high-level constraints by moving detailed runbooks to dedicated documents.
  • Use Case: After migrating a Docker service to a new host, use this Skill to update the central AGENTS.md, ensure Dashy shortcuts point to the correct service, and update the overview.json snapshot.

Quick Start

Use the infrastructure-doc-sync skill to update documentation after a Docker service has been moved to a new host.

Frequently Asked Questions about infrastructure-doc-sync

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I keep infrastructure documentation synchronized after moving a Docker service to a new host?

To keep infrastructure documentation synchronized after a Docker service move, you must update AGENTS files, READMEs, and Dashy configurations to reflect the operational changes and prevent documentation drift across your system topology.

What is the best way to prevent documentation drift in infrastructure runbooks?

Preventing documentation drift requires keeping AGENTS files concise by moving detailed runbook content into dedicated documents, ensuring infra info snapshots remain current and accurately reflect operational changes.

How does moving runbook content to dedicated documents improve AGENTS file management?

Moving runbook content to dedicated documents improves AGENTS file management by maintaining a focused high-level scope for agent constraints, ensuring infra info snapshots and Dashy configurations stay clear and accurate.

Do I need to manually update Dashy configurations when infrastructure changes occur?

You need to update Dashy configurations when infrastructure changes occur to ensure shortcuts point to the correct service locations, alongside updating AGENTS files and overview.json snapshots to maintain system clarity.

What content rules must be followed when updating infra info snapshots and AGENTS files?

Updating infra info snapshots and AGENTS files requires adherence to specific content rules for each format to maintain clarity, accuracy, and proper scope separation between high-level constraints and detailed runbooks.

Can I use this approach to update READMEs and Dashy shortcuts simultaneously after network updates?

You can update READMEs and Dashy shortcuts simultaneously after network updates by synchronizing infrastructure documentation, ensuring all relevant configurations and snapshots reflect the new operational state across your system topology.