Is this skill meant to be used standalone?

While it can be used alone, it is designed to be part of a release automation workflow, typically following a project detection phase to ensure all version files are identified.

Does it only update configuration files?

No, it also intelligently updates documentation files like README.md, searching for version badges, installation commands, and git tag references to ensure everything is current.

Which project types are supported by Documentation Sync?

It supports a wide range of ecosystems including Node.js (package.json), Python (pyproject.toml, __version__.py), Rust (Cargo.toml), Java (Maven, Gradle), and generic text-based version files.

How does it prevent accidental replacements of unrelated numbers?

The skill uses a conservative replacement strategy with word boundaries and context markers (like 'v', '@', or '==') to ensure it only updates strings that look like version references.

Can it handle lockfiles for Node.js and Rust?

Yes, it automatically manages updates for package-lock.json and Cargo.lock to keep your dependency graphs in sync with the new project version.

Documentation Sync

Name: Documentation Sync
Author: jayteealao

byjayteealao

0•

배포 및 DevOps

Automates version number synchronization across project configuration files and documentation to ensure consistent release branding.

Documentation Sync is a specialized Claude Code skill designed to eliminate manual versioning errors by automatically updating version strings across an entire codebase. It utilizes smart adapters for various file formats like JSON, TOML, and XML while performing context-aware replacements in documentation files. Whether updating npm install commands, version badges, or internal version constants, this skill ensures that every reference to your software's version remains accurate and synchronized during the release process, reducing the risk of broken links and outdated installation instructions.

주요 기능

01Context-aware version replacement in Markdown files for badges, install commands, and tags.

02Automated validation and git diff generation for safe version transitions.

030 GitHub stars

04Supports multiple ecosystems including Node.js, Python, Rust, Go, and Java.

05Native adapters for common configuration files like package.json, Cargo.toml, and pom.xml.

06Handles complex lockfile updates for package managers like npm and Cargo.

사용 사례

01Synchronizing project versions across README files and install guides before a major release.

02Automating the tedious task of updating version badges and CDN links in documentation.

03Updating version constants in source code alongside configuration file changes.

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add jayteealao/agent-skills documentation-sync

For use in Claude.ai and ChatGPT

Download Skill