doc-maintenance-sync

Update AGENTS.md and docs sections to reflect current codebase changes.

5|1|Updated May 9, 2026
One-click install
npx skills add https://github.com/ql-link/LinkRag --skill doc-maintenance-sync
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-maintenance-sync
Source: https://github.com/ql-link/LinkRag/tree/main/.ai/skills/doc-maintenance-sync
Command: npx skills add https://github.com/ql-link/LinkRag --skill doc-maintenance-sync

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill ensures project documentation stays aligned with the actual codebase by automatically identifying outdated docs and applying minimal, necessary updates across AGENTS.md, docs/, and contributing notes. It is used when documentation lags behind code changes and needs synchronized updates without overhauling contracts.

Core Features & Use Cases

  • Minimal necessary doc sync driven by contract changes.
  • Synchronizes AGENTS.md, docs/api, docs/internals, docs/ops, docs/contributing.md to reflect current code.
  • Use case: after modifying parsing or architecture, trigger this skill to update documentation to reflect new interfaces and processes.

Quick Start

Run the maintenance-sync to update and align AGENTS.md and docs with the latest code changes.

Frequently Asked Questions about doc-maintenance-sync

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

FAQPage Schema
How do I automatically sync markdown documentation with code changes?

Automatically sync markdown documentation with code changes by triggering maintenance-sync to update AGENTS.md and docs sections, applying minimal necessary updates to reflect new APIs, schemas, and workflows without overhauling contracts.

What is the best way to update AGENTS.md after modifying project architecture?

Update AGENTS.md after modifying project architecture by running automated documentation synchronization, which scans recent codebase changes and applies minimal updates to AGENTS.md, docs/api, docs/internals, and docs/ops to reflect new interfaces and processes.

How does automated documentation alignment preserve existing layout and contracts?

Automated documentation alignment preserves existing layout and contracts by enforcing minimal necessary updates, scanning repository structure and changes to reflect new APIs and schemas in docs/contributing.md and related sections without overhauling the original documentation layout.

Does documentation synchronization work with contract-guard and config-contract-sync mappings?

Documentation synchronization works with contract-guard and config-contract-sync mappings, covering related doc mappings to keep AGENTS.md, docs/api, docs/internals, docs/ops, and docs/contributing.md accurate and aligned with the current codebase.

Can I update docs across multiple directories like api, internals, and ops at once?

Update docs across multiple directories like api, internals, and ops at once by running maintenance-sync, which applies synchronized updates across AGENTS.md, docs/api, docs/internals, docs/ops, and docs/contributing.md to accurately reflect recent codebase changes.

When should I not use automated documentation sync for my repository?

Avoid automated documentation sync when your documentation requires a complete overhaul rather than minimal necessary updates, as this process enforces preserving existing documentation layout and contracts while only reflecting new APIs, schemas, and workflows.