spec-driven-promote

Merge versioned Markdown docs into current documentation and remove obsolete folders.

Updated Nov 12, 2017

Search Tags:#automation #versioning #documentation #spec-driven #docs #consolidation

Ready to run

npx skills add https://github.com/ak110/dotfiles --skill spec-driven-promote

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: spec-driven-promote
Source: https://github.com/ak110/dotfiles/tree/main/plugins/agent-toolkit/skills/spec-driven-promote
Command: npx skills add https://github.com/ak110/dotfiles --skill spec-driven-promote

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Next-version documentation (docs/v{next}) is not integrated into the current, customer-facing docs, leading to fragmentation and drift. This skill merges the upcoming docs into the existing docs (docs/features/ and docs/topics/), and removes docs/v{next} after promotion to maintain a single source of truth.

Core Features & Use Cases

Identify and collect candidate .md files from docs/v{next}, excluding OVERVIEW.md, and map them to their current equivalents in docs/features/ or docs/topics/.
Update cross-references and links to reflect the new locations and ensure references no longer point to docs/v{next}.
Enforce the removal of docs/v{next} after successful promotion and validate the integrity of the updated documentation structure.

Quick Start

Initiate the promotion workflow by running the agent-toolkit:spec-driven-promote command and follow the prompts.

Frequently Asked Questions about spec-driven-promote

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

FAQPage Schema

How do I merge next-version documentation into current docs?▼

To merge next-version documentation, collect Markdown files from docs/v{next}, map them to existing equivalents in docs/features/ and docs/topics/, update cross-references, and remove the obsolete folder to maintain a single source of truth.

What is the best way to consolidate versioned Markdown files into a single source?▼

The best way to consolidate versioned Markdown files is to promote content from docs/v{next} into current directories, update internal links to reflect new locations, and delete the next-version folder after validating structure integrity.

How does documentation promotion handle cross-references between versions?▼

Documentation promotion handles cross-references by updating links during the merge process, ensuring all references point to the current docs/features/ and docs/topics/ directories instead of the deprecated docs/v{next} folder.

Can I keep the docs/v{next} folder after promoting content to current docs?▼

No, you cannot keep the docs/v{next} folder after promotion. The integration policy enforces removing docs/v{next} after successful content merge to prevent fragmentation and documentation drift.

What happens to OVERVIEW.md files during next-version documentation consolidation?▼

During next-version documentation consolidation, OVERVIEW.md files are excluded from the candidate collection process, meaning they are not mapped or merged into the current docs/features/ or docs/topics/ directories.

Why does versioned documentation drift from current customer-facing docs?▼

Versioned documentation drifts from current customer-facing docs when next-version content in docs/v{next} is not integrated into existing structures, causing fragmentation across separate directories over time.