docs-updater

Featured

Provides automated documentation updates by analyzing git changes between the current branch and the last release tag. Performs git diff analysis to identify modifications, then updates README.md, CHANGELOG.md following Keep a Changelog standard, and discovers documentation folders for contextual updates. Use when preparing a release, maintaining documentation sync, or before creating a pull request. Triggers on "update docs", "update changelog", "sync documentation", "update readme", "prepare release documentation".

Code & Development 330 stars 39 forks Updated 2 days ago MIT

Install

View on GitHub

Quality Score: 91/100

Stars 20%
84
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Universal Documentation Updater Analyzes git changes since the latest release tag and updates the documentation files that should change with them. ## Overview Use git history to identify release-relevant changes, then update `README.md`, `CHANGELOG.md`, and any relevant documentation folders. Keep the workflow focused on explicit user approval, precise edits, and repository-specific documentation structure. ## When to Use Use this skill when: - Preparing release notes or an `Unreleased` changelog update - Syncing `README.md` or documentation after feature work lands - Reviewing what changed since the last release before a PR or release ## Prerequisites Before starting, verify that the following conditions are met: ```bash # Verify we're in a git repository git rev-parse --git-dir # Check that git tags exist git tag --list | head -5 # Verify documentation files exist test -f README.md || echo "README.md not found" test -f CHANGELOG.md || echo "CHANGELOG.md not found" ``` If no tags exist, inform the user that this skill requires at least one release tag to compare against. ## Instructions ### Phase 1: Detect Last Release Version **Goal**: Identify the latest released version to compare against. **Actions:** 1. Detect the comparison baseline and display it: ```bash LATEST_TAG=$(git describe --tags --abbrev=0 2>/dev/null) if [ -z "$LATEST_TAG" ]; then echo "No git tags found. This skill requires at least one release tag." echo "Please create a relea...

Details

Author
giuseppe-trisciuoglio
Repository
giuseppe-trisciuoglio/developer-kit
Created
10 months ago
Last Updated
2 days ago
Language
Python
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category