documentation-sync

Name: documentation-sync
Availability: InStock
Author: jayteealao

Synchronize version numbers across project files and documentation references.

Updated Dec 29, 2025

Search Tags:#automation #versioning #documentation #CI/CD #adapters #multi-project

Ready to run

npx skills add https://github.com/jayteealao/Aperture --skill documentation-sync-jayteealao

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation-sync
Source: https://github.com/jayteealao/Aperture/tree/main/.claude/skills/documentation-sync
Command: npx skills add https://github.com/jayteealao/Aperture --skill documentation-sync-jayteealao

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Synchronize version numbers across diverse project types by applying version file adapters and ensuring consistent references in documentation.

Core Features & Use Cases

Adapter-driven updates: Update version fields across JSON, TOML, Python, Gradle, Maven, and other formats using a centralized configuration.
Documentation synchronization: Propagate version changes into README/docs to maintain consistency.
Use Case: When releasing a new version, propagate the new version across all version files and related docs, with a diff for review.

Quick Start

Run the documentation-sync skill to propagate a new version from old_version to new_version across the repository.

Frequently Asked Questions about documentation-sync

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

FAQPage Schema

How do I sync version numbers across multiple projects in different programming languages?▼

To sync version numbers across multiple projects, adapter-driven updates target Node.js, Python, Rust, Go, and Java version files, ensuring all references match the new release version.

What's the best way to update version references in documentation during a release?▼

Updating version references in documentation during a release involves propagating the new version number into README and docs files, maintaining consistency across all project documentation.

Does version synchronization work with both Node.js package.json and Rust Cargo.toml files?▼

Yes, version synchronization works with Node.js package.json and Rust Cargo.toml files by applying specific version file adapters for JSON, TOML, Gradle, Maven, and other formats.

How do I generate a git diff for version changes across a multi-project repository?▼

To generate a git diff for version changes, apply the appropriate adapters to update version files and documentation references, which produces a validated diff for review before committing.

Can I automate documentation synchronization as part of a CI/CD pipeline?▼

Yes, you can automate documentation synchronization in a CI/CD pipeline by loading centralized project configuration for version and documentation files, applying adapters, and outputting diffs for automated review.