skills.rest
NAMEWTA
NAMEWTACOMMUNITY
Explore all skills by this author →
GitHub

Docs Sync

Audit and synchronize project documentation against reproducible Git commit ranges.

2|Updated Jul 6, 2026
Search Tags:#git#changelog#documentation#readme#monorepo#sync#agents.md
One-click install
npx skills add https://github.com/NAMEWTA/learning-open-code --skill docs-sync-namewta
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: Docs Sync
Source: https://github.com/NAMEWTA/learning-open-code/tree/main/speculo/skills/docs-sync
Command: npx skills add https://github.com/NAMEWTA/learning-open-code --skill docs-sync-namewta

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) and assets (resource) components.

What problem does it solve? Project documentation drifts out of sync with code as commits accumulate. This Skill audits README, CHANGELOG, and AGENTS.md/CLAUDE.md agent handbooks against a reproducible Git range, then updates, merges, or deletes stale content under explicit scope confirmation. ## Core Features & Use Cases - Reproducible Git-range auditing: Resolves the last sync baseline from a versioned state file, diffs FROM_SHA..INPUT_HEAD, and maps changes to documentation lifecycle actions (add, update, delete, merge, keep, propose-only). - Agent handbook maintenance: Incrementally maintains or fully rebuilds AGENTS.md trees with manifest discovery, role classification (repo-root, aggregator, runnable-app, capability-module, contract-module, scripts-docs), and fixed CLAUDE.md redirects. - README and CHANGELOG contracts: Enforces a nine-section README structure with an English README.md plus mirrored README-ZH.md, and Keep a Changelog conventions derived from actual diffs rather than commit messages. - Use Case: After a sprint of merged pull requests, run the Skill to checkpoint the workspace, confirm documentation scope, regenerate stale agent handbooks, and commit synchronized docs with an auditable report and state file. ## Quick Start Ask the agent to run docs-sync to audit all project documentation against the commits since the last sync and update the README, CHANGELOG, and AGENTS.md files accordingly.

Frequently Asked Questions about Docs Sync

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

FAQPage Schema
How do I keep AGENTS.md files in sync with my codebase?▼

Run the docs-sync flow, which discovers manifest files across the repository, classifies each directory into a role such as aggregator or runnable-app, collects file-based evidence, and regenerates or incrementally updates each AGENTS.md. CLAUDE.md files are reduced to fixed redirects pointing at AGENTS.md.

How to generate a CHANGELOG from git commits automatically?▼

The Skill reads the full diff of the range recorded in its state file rather than dumping git log output. It aggregates user-visible changes into Keep a Changelog categories, skips internal refactors and formatting, and only moves entries out of Unreleased when a real version tag exists.

Does docs-sync support bilingual README files?▼

Yes. The README contract mandates that README.md is always English with a paired README-ZH.md Chinese mirror. Both files must be updated in the same sync pass, and the change is blocked if one language version cannot be synchronized.

What happens if my git working tree is dirty before syncing docs?▼

The Skill inspects staged, unstaged, and untracked changes, runs the repository's declared checks, and either blocks on conflicts or risky files or creates an explicit checkpoint commit. It never uses git add ., stash, reset, or history rewriting.

Can docs-sync delete outdated documentation files?▼

Deleting stale paragraphs, commands, and links within a tracked document is routine synchronization. Deleting entire files or directories, modifying protected knowledge stores, or expanding scope requires explicit per-action user confirmation and is otherwise recorded as propose-only.

Related Skills

Explore More Software Engineering Skills→
FacturaScriptsFacturaScripts
7

skill-commit

Guide Git commit message creation using Conventional Commits best practices.

Official
Intermediate
BlockRunAIBlockRunAI
6.6k

release

Executes the full ClawRouter release checklist from version bump through npm publish and GitHub release.

Official
Intermediate
fgrehmfgrehm

blog-proofreading

Proofread blog posts for flow, broken links, and formatting issues.

Community
Basic
savvy-websavvy-web

rspress-api-docs

Generate RSPress API documentation from TypeScript source files.

Official
Advanced