Does it handle uncommitted changes?

Yes, it examines both uncommitted changes in your working directory and the differences between your current branch and the main branch.

Does it support different documentation formats?

Yes, it uses Glob patterns to find and read .md files and other documentation formats commonly found in software repositories.

Can it find outdated information that hasn't changed recently?

Yes, it features a stale document detection tool that flags any documentation files that have not been modified in over 90 days.

How does the skill identify what documentation to update?

It analyzes git diffs and commit history to detect specific changes in dependencies, environment variables, scripts, and API structures, then finds matching documentation sections.

Documentation Sync

Name: Documentation Sync
Author: Doarakko

byDoarakko

0•

学习与文档

Synchronizes project documentation automatically based on code changes and git branch history.

This skill automates the critical task of keeping project documentation accurate by analyzing code changes within your current git branch. It identifies modifications to dependencies, environment variables, scripts, and APIs, then maps those changes to relevant documentation files like READMEs or setup guides. By comparing your working branch against the main branch and detecting stale files that haven't been updated in months, this skill ensures that your documentation never falls behind your codebase.

主要功能

01Stale document detection for files unupdated for over 90 days

020 GitHub stars

03Automated git diff and log analysis to identify code changes

04Smart discovery and editing of relevant Markdown and documentation files

05Summarized reporting of all documentation modifications

06Impact assessment for dependencies, scripts, and environment variables

使用场景

01Synchronizing API documentation with recently modified routing or endpoint definitions

02Auditing large repositories to find and refresh outdated project guides

03Updating setup instructions after adding new environment variables or dependencies

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add doarakko/dotfiles docs-update

For use in Claude.ai and ChatGPT

Download Skill