sync-docs

Analyze changed files and docs to report documentation issues.

951|110|Updated Jan 15, 2026
One-click install
npx skills add https://github.com/agent-sh/agentsys --skill sync-docs-agent-sh
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: sync-docs
Source: https://github.com/agent-sh/agentsys/tree/main/.kiro/skills/sync-docs
Command: npx skills add https://github.com/agent-sh/agentsys --skill sync-docs-agent-sh

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Maintains alignment between documentation and code by automatically detecting documentation gaps, version drift, and changelog consistency as code evolves.

Core Features & Use Cases

  • Docs discovery & correlation: scanning for README.md, CHANGELOG.md, and docs/, then linking docs to changed code.
  • Issue detection: flags outdated versions, removed exports, code example drift, and import-path changes.
  • Changelog validation: checks for unreleased entries and consistency with recent commits.
  • Structured reporting: outputs a machine-readable report suitable for orchestration and optional fix proposals.

Quick Start

Run sync-docs with a scope to scan recent changes and generate a report of documentation issues.

Frequently Asked Questions about sync-docs

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

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

You can detect outdated code examples in documentation by scanning for code example drift and removed exports. This analysis flags discrepancies between your current codebase and the examples shown in your README or docs directory.

How do I validate changelog consistency with recent git commits?

To automate documentation gap detection before a PR, apply a before-pr scope control to determine the documentation surface. This limits the analysis to recent changes and flags undocumented exports safely.

Can I generate a structured report of documentation issues for automated fixes?

Yes, you can generate a structured, fix-preservation-enabled report of documentation issues. This machine-readable output is suitable for orchestration to propose and apply safe, auto-generated fixes by a separate agent.

What is the best way to find import-path drift in documentation?

The best way to find import-path drift in documentation is to perform code analysis that correlates changed files with related docs. This process flags outdated import paths and version drift automatically.