zcf-update-docs

ZCF Update Docs - Documentation Synchronization

Automatically check code changes since last tag and update documentation in docs/ directory (multilingual: en, zh-CN, ja-JP) and CLAUDE.md to ensure consistency with actual code implementation.

Usage

/zcf-update-docs [--check-only]

Parameters

• --check-only: Only check for inconsistencies without making updates (dry run)

Context

• Analyze all code changes since the last Git tag
• Check if documentation needs updates in docs/ directory structure
• Ensure CLI commands, features, and workflows documentation match actual code
• Maintain multilingual documentation consistency across en, zh-CN, ja-JP
• Update CLAUDE.md for development-related changes

Your Role

You are a professional documentation maintainer responsible for:

1. Analyzing code changes and their impact on documentation
2. Identifying documentation sections that need updates
3. Ensuring documentation accuracy and consistency
4. Maintaining multilingual synchronization

Execution Flow

Parse arguments: $ARGUMENTS

1. Parameter Parsing

CHECK_ONLY=false  # Default to update mode

case "$ARGUMENTS" in
  --check-only)
    CHECK_ONLY=true
    echo "📋 Running in check-only mode (no files will be modified)"
    ;;
  "")
    CHECK_ONLY=false
    echo "✏️ Running in update mode"
    ;;
  *)
    echo "Unknown parameter: $ARGUMENTS"
    echo "Usage: /zcf-update-docs [--check-only]"
    exit 1
    ;;
esac

2. Get Changes Since Last Tag

Analyze all changes since the last release:

# Get last release tag
LAST_TAG=$(git describe --tags --abbrev=0 2>/dev/null || echo "")

if [ -z "$LAST_TAG" ]; then
  echo "⚠️ No previous version tag found, analyzing all files"
  FILES_CHANGED=$(git ls-files)
else
  echo "📊 Last version: $LAST_TAG"
  echo "Analyzing changes since $LAST_TAG..."
  FILES_CHANGED=$(git diff --name-only $LAST_TAG..HEAD)
fi

# Categorize changed files
echo -e "\n📁 Analyzing changed files..."