skills.rest
joi-fairshare
joi-fairshareCOMMUNITY
Explore all skills by this author →
GitHub

syncDocs

Refresh README, ARCHITECTURE.md, CHANGELOG.md, and CLAUDE.md from git commits.

1|2|Updated Mar 19, 2026
Search Tags:#automation#git#changelog#reports#documentation#release#sync
One-click install
npx skills add https://github.com/joi-fairshare/agentic-workflow --skill syncdocs
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: syncDocs
Source: https://github.com/joi-fairshare/agentic-workflow/tree/main/skills/syncDocs
Command: npx skills add https://github.com/joi-fairshare/agentic-workflow --skill syncdocs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Prevents documentation from lagging behind code by refreshing README, planning/ARCHITECTURE, CHANGELOG, and CLAUDE.md after shipping so every stakeholder reads accurate guidance.

Core Features & Use Cases

  • Parses the git range since the last tag (or fallback) and feeds commit summaries plus diffs into dedicated agents for each document to minimize edits and preserve structure.
  • Lets you focus on a subset of docs by scoping updates to readme, architecture, changelog, or CLAUDE.md while still generating commits and a timestamped release report when changes occur.
  • Ideal for post-release ceremonies where the product and engineering teams need consistent handoff notes without rewriting entire files.

Quick Start

Run the syncDocs skill after merging to refresh README, architecture notes, changelog, and CLAUDE.md.

Frequently Asked Questions about syncDocs

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

FAQPage Schema
How do I update documentation after merging git commits to reflect recent code changes?▼

To automate documentation updates after merging, parse the git range since the last tag to refresh stale README, ARCHITECTURE, CHANGELOG, and CLAUDE.md sections using commit summaries and diffs.

Can I update only the changelog without modifying the README and architecture docs?▼

Yes, you can scope updates to specific documents by targeting the changelog flag. This limits edits to stale CHANGELOG.md sections while skipping README, architecture, and CLAUDE.md files.

What is the best way to keep architecture notes and planning docs aligned with feature releases?▼

Keeping architecture notes aligned involves feeding git commit summaries and diffs into dedicated agents that refresh stale ARCHITECTURE.md sections while preserving existing document structure.

Does this documentation sync tool require specific dependencies or components to run?▼

No, this documentation sync tool requires no external dependencies or components to run. It operates independently by parsing git commit ranges and applying targeted edits to workflow documents.

How do I generate a release report after updating project documentation?▼

To generate a release report after updating documentation, commit the refreshed changes and produce a timestamped release report automatically when document edits occur within the scoped range.

Related Skills

Explore More Software Engineering Skills→
mgratzermgratzer
65

forge-setup-project

Create CLAUDE.md, AGENTS.md, docs/, README, and CHANGELOG.md for Forge projects.

Community
Intermediate
TMI-appsTMI-apps
2

push

Validate and push committed Git changes to a remote repository.

Official
Intermediate
googlegoogle
68

release-process

Automate Capsem release workflows from pre-release checks to post-release verification.

Official
Advanced
dt418dt418

Docs Pack

Build documentation platforms with versioned docs, search, navigation, code highlighting, and API reference generation.

Community
Intermediate