agents-md-sync

Detect drift between AGENTS.md files and the codebase and apply minimal updates.

1|Updated Nov 27, 2022

Search Tags:#documentation #markdown #codebase #reference #agents #quality-assurance #docs-sync

Ready to run

npx skills add https://github.com/gonzalopozo/gonzalopozo.github.io --skill agents-md-sync

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: agents-md-sync
Source: https://github.com/gonzalopozo/gonzalopozo.github.io/tree/main/.cursor/skills/agents-md-sync
Command: npx skills add https://github.com/gonzalopozo/gonzalopozo.github.io --skill agents-md-sync

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Drift between AGENTS.md and the codebase is detected and fixed with minimal surgical updates to keep docs in sync with reality.

Core Features & Use Cases

Detect drift between AGENTS documentation and the codebase.
Apply only the edits needed to stale sections.
Verify cross-references to maintain documentation integrity.

Quick Start

Gather a structural snapshot of the codebase, compare each AGENTS section against reality, apply only the edits needed, and verify cross-references.

Frequently Asked Questions about agents-md-sync

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

FAQPage Schema

How do I keep markdown documentation in sync with my codebase after structural changes?▼

You can keep markdown documentation in sync by detecting drift between AGENTS.md files and the actual codebase, applying only minimal surgical updates to stale sections affected by structural changes.

What is the best way to update stale AGENTS.md files without disrupting the repository?▼

The best way to update stale AGENTS.md files is applying minimal surgical edits only to outdated sections, verifying cross-references, and producing a synchronized set of AGENTS-*.md files with minimal disruption.

How do I verify cross-references in markdown documentation after route restructures?▼

You verify cross-references in markdown documentation by comparing each AGENTS section against the actual codebase reality and checking cross-references to maintain documentation integrity after route restructures.

Can I apply documentation updates only to specific stale sections instead of rewriting the whole file?▼

Yes, you can apply documentation updates only to specific stale sections. The process identifies drift and applies minimal surgical edits solely to outdated parts, leaving the rest of the file untouched.

When do I need to synchronize AGENTS.md files with dependency updates?▼

You need to synchronize AGENTS.md files with dependency updates when drift occurs between the documentation and the actual codebase, requiring minimal surgical updates to keep docs aligned with reality.