skill-doc-sync

Featured

Post-ship doc sync across project markdown. Use when: sync docs, update docs, document changes, release notes.

AI & Automation 3,887 stars 365 forks Updated today MIT

Install

View on GitHub

Quality Score: 99/100

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

Skill Content

# Post-Ship Documentation Synchronization Automated documentation synchronization for the Deliver phase. After code is committed and a PR is created, this skill reads all `.md` files in the project, cross-references the diff, auto-updates factual content, checks cross-doc consistency, and updates the PR body. --- ## Caps - **Max 30 doc files scanned** — skip files beyond the cap, warn the user - **Never clobber CHANGELOG** — append only, never delete existing entries - **Ask user before changing narrative/philosophy sections** — risky changes require confirmation --- ## Step 1: Discover Docs Find all `.md` files in the project root (max depth 2), skipping `node_modules/` and `.git/`. ```bash # Discover all markdown files (max depth 2, skip noise directories) DOC_FILES=$(find . -maxdepth 2 -name '*.md' \ -not -path './node_modules/*' \ -not -path './.git/*' \ -not -path './vendor/*' \ -not -path './.claude/*' \ 2>/dev/null | head -30) DOC_COUNT=$(echo "$DOC_FILES" | wc -l | tr -d ' ') echo "Found $DOC_COUNT doc files to scan (cap: 30)" if [[ "$DOC_COUNT" -ge 30 ]]; then echo "WARNING: Doc file cap reached (30). Some files may be skipped." fi ``` Read each discovered doc file so you have their current content in context. --- ## Step 2: Cross-Reference Diff Run `git diff --stat HEAD~1` (or diff against the base branch if on a feature branch) to identify which files changed and what content may now be stale in each doc. ```bash # Get the diff stat to id...

Details

Author
nyldn
Repository
nyldn/claude-octopus
Created
6 months ago
Last Updated
today
Language
Shell
License
MIT

Integrates with

Bundled in these plugins

Similar Skills

Semantically similar based on skill content — not just same category