sync-docs

Synchronizes project documentation with new sections from the installed plugin scaffold changelog.

Updated Aug 25, 2026
One-click install
npx skills add https://github.com/asengardeon/btt-sdd-pipeline --skill sync-docs-asengardeon
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: sync-docs
Source: https://github.com/asengardeon/btt-sdd-pipeline/tree/main/plugins/btt-sdd/skills/sync-docs
Command: npx skills add https://github.com/asengardeon/btt-sdd-pipeline --skill sync-docs-asengardeon

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Project documentation files (CLAUDE.md, docs/*.md) generated from an older version of the btt-sdd plugin scaffold become outdated when the plugin template gains new sections, and this Skill detects and applies those missing sections without overwriting project customizations. ## Core Features & Use Cases - Changelog-Based Gap Detection: Compares the project's recorded plugin version against the installed plugin's CHANGELOG.md to find scaffold sections added since the last sync. - Bidirectional Structural Comparison: Scans section headings in both directions (project to scaffold and scaffold to project) to catch missing sections and entirely missing files, including retroactive coverage for versions before 1.15.0. - User-Approved Additive Updates: Presents every candidate section for approval before applying changes as pure additions, then commits on a dedicated branch and opens a PR. - Use Case: After running a plugin update, a project maintainer invokes the sync to discover that docs/POST-MERGE-VALIDATION.md and three new CLAUDE.md sections are missing, approves them, and gets a ready-to-review PR. ## Quick Start Ask the assistant to run the sync-docs utility to check whether the project documentation is missing any sections from the currently installed btt-sdd plugin version.

Frequently Asked Questions about sync-docs

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

FAQPage Schema
How do I sync project docs after updating the btt-sdd plugin?▼

Run the sync-docs command after a plugin update. It reads the installed plugin version, compares the changelog and scaffold structure against your project docs, lists missing sections for approval, and commits approved additions on a dedicated branch with a PR.

What does the docs/.sdd-plugin-version marker file do?▼

The marker records which plugin version was last verified against the project docs. It prevents re-scanning the full changelog on every sync, and it is updated even if you reject candidate sections, since it means the version was checked, not that everything was applied.

Does sync-docs overwrite my customized documentation?▼

No. Approved sections are applied as pure additions at the position matching the template, without modifying any existing lines. Entire files are only copied when they are completely absent from the project, so no project content is lost.

Why does sync-docs run a structural comparison for versions before 1.15.0?▼

The plugin changelog only tracks scaffold changes from version 1.14.0, and the retroactive structural comparison was introduced in 1.15.0. Projects marked before that version never received the full scan, so the comparison reruns once to catch older gaps.

When should I not use sync-docs?▼

Do not use it on projects distributed via junction rather than the installed plugin, since those do not have the scaffold divergence problem. The command detects this case and stops without making changes.