skills.rest
jMerta
jMertaCOMMUNITY
Explore all skills by this author →
GitHub

docs-sync

Align documentation with code changes using repository diffs.

130|15|Updated Dec 14, 2025
Search Tags:#documentation#adr#readme#docs#runbooks#docs-sync#release-readiness
One-click install
npx skills add https://github.com/jMerta/codex-skills --skill docs-sync-jmerta
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs-sync
Source: https://github.com/jMerta/codex-skills/tree/main/docs-sync
Command: npx skills add https://github.com/jMerta/codex-skills --skill docs-sync-jmerta

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Keep documentation aligned with evolving code by ensuring READMEs, docs sites, API docs, runbooks, and configuration reflect current behavior and release needs.

Core Features & Use Cases

  • Identify impacted documentation surfaces from code changes (README.md, docs/, API specs, ADRs, changelog).
  • Propose and apply updates to align content with code behavior; supports ADR templates for architectural decisions.
  • Use during releases, PR prep, or refactors to ensure documentation quality and consistency.

Quick Start

Run the docs-sync skill to align repository docs with the latest code changes. Review and apply the suggested updates to READMEs, docs/, and ADRs before opening a PR.

Frequently Asked Questions about docs-sync

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

FAQPage Schema
How do I keep documentation in sync with code changes before a release?▼

Keeping documentation in sync with code changes involves analyzing repository diffs to identify impacted surfaces like READMEs, API specs, and runbooks, then proposing updates using ADR templates before opening a PR.

What is the best way to update ADRs and runbooks during a refactor?▼

The best way to update ADRs and runbooks during a refactor is to align documentation surfaces with current behavior by relying on standard Git workflows and repository diffs to propose structured ADR template updates.

Do I need extra tooling to align README files with repository diffs?▼

Aligning README files with repository diffs requires no additional tooling beyond standard Git workflows, using the diffs to identify and propose updates that reflect current release needs.

How does identifying impacted documentation surfaces from code changes work?▼

Identifying impacted documentation surfaces works by analyzing repository diffs across code changes to locate outdated content in docs sites, configuration files, and changelogs, then proposing updates to match current behavior.

Can I use standard doc structures to prepare documentation for PR prep?▼

You can prepare documentation for PR prep by applying standard doc structures and ADR templates to format changes, ensuring READMEs and API docs reflect current guidelines and behavior before submitting.

Related Skills

Explore More Content & Communication Skills→
diriendirien
19

scout

Identify the top 3 highest-impact improvements in files touched by a diff.

Community
Intermediate
simonheimlichersimonheimlicher
1

architecting-typescript

Create Architecture Decision Records for TypeScript architecture decisions.

Community
Advanced
putrawitamaputrawitama
1

document-release

Detect documentation drift across READMEs, architecture docs, and changelogs.

Community
Advanced
clover-stormclover-storm

sync-docs

Detect code changes from git diffs and update corresponding documentation sections.

Community
Intermediate