skills.rest
AgentSystemLabs
AgentSystemLabsOFFICIAL
Explore all skills by this author →
GitHub

sync-docs

Update existing documentation files to match current codebase changes.

121|2|Updated Apr 24, 2026
Search Tags:#code quality#documentation#openapi#swagger#change detection#api updates#env config
One-click install
npx skills add https://github.com/AgentSystemLabs/core --skill sync-docs-agentsystemlabs
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: sync-docs
Source: https://github.com/AgentSystemLabs/core/tree/main/plugins/agentsystem-core/skills/sync-docs
Command: npx skills add https://github.com/AgentSystemLabs/core --skill sync-docs-agentsystemlabs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Prevents stale project documentation by updating existing files to exactly match the latest code, APIs, config, and UX changes.

Core Features & Use Cases

  • Locks documentation to the current code by identifying what changed first, then updating only the relevant existing doc surfaces.
  • Updates common authoritative artifacts in-place including Swagger/OpenAPI specs, README, CHANGELOG, ADRs (with supersession notes when appropriate), .env.example, setup guides, and inline documentation comments.
  • Avoids doc bloat and risky edits by never creating new documentation files and never modifying generated docs, instead updating the underlying source.

Quick Start

Ask the agent to run sync-docs after your last commit so it updates the existing README, Swagger/OpenAPI, and environment/config docs to match the changed endpoints, flags, and dependencies.

Frequently Asked Questions about sync-docs

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

FAQPage Schema
How do I keep OpenAPI and Swagger specs in sync after code changes?▼

You can keep Swagger and OpenAPI specs in sync by detecting codebase changes first, then applying targeted edits to the existing spec files. This ensures API surface updates match the latest endpoints without modifying generated docs directly.

How do I update README and .env.example after adding new config keys?▼

Update README and .env.example after config additions by synchronizing in-repo documentation with the current codebase. It applies edits only to existing environment/config doc surfaces when stale keys are detected, never creating new files.

What is the best way to automate documentation updates after a commit?▼

Automating documentation updates involves detecting code changes from the last commit and updating only stale doc surfaces. This includes README, Swagger, ADRs, and CHANGELOG entries to match modified endpoints, flags, and dependencies.

Does syncing docs after API updates modify generated output files?▼

No, syncing docs after API updates never modifies generated outputs. Instead, it edits the underlying source spec or configuration file directly to ensure the authoritative artifact remains the single source of truth.

Can I use this to create new ADR files when architecture changes?▼

No, you cannot use this to create new ADR files. It only updates existing Architecture Decision Records by adding supersession notes when appropriate, strictly avoiding the creation of any new documentation files.

Why does my inline documentation still show stale CLI signatures after updates?▼

Inline documentation may show stale CLI signatures if the change detection mechanism did not confirm those public signature changes as stale. It guarantees edits only when doc surfaces are confirmed outdated by the latest codebase updates.

Related Skills

Explore More Software Engineering Skills→
Sir-chawakornSir-chawakorn
9

write-docs

Generate and maintain project documentation from source code and git history.

Community
Advanced
traylinxtraylinx
2

api-designer

Design REST APIs and OpenAPI specifications with endpoint naming and schema validation.

Official
Advanced
Kushal9889Kushal9889

husky

Sets up Husky git hooks to automate code quality checks and testing before commits.

Community
Intermediate
chirag-cschirag-cs

api-documentation-generator

Parse source code to generate OpenAPI specs and Markdown API documentation.

Community
Intermediate