mcpField
D
docs-sync

docs-sync

github.com/drillanDevelopment358 installsUpdated 41w ago
Repository

About docs-sync

docs-sync updates project documentation after `/speckit.implement` completes, using implementation details and specification files as sources. It maintains README.md, CHANGELOG.md, and API documentation while preserving content outside marked sections.

Key features

  1. 01Update README.md usage and feature sections
  2. 02Add CHANGELOG.md entries
  3. 03Synchronize API documentation
  4. 04Preserve content outside markers
  5. 05Report changed files and diff summary

Use cases

  1. 01Refresh docs after implementation
  2. 02Record completed work in a changelog
  3. 03Align API docs with contracts
  4. 04Review documentation updates and errors

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/drillan/speckit-gates --skill docs-sync

After installing, type/docs-syncin Claude Code to confirm it loaded.

Bundled filesscripts/sync.sh

Details

From the project README

docs-sync

Synchronizes documentation with implementation after /speckit.implement completes.

Purpose

This skill automatically updates documentation to reflect the implemented features. It:

  • Updates README.md: Adds/updates usage section with implementation details
  • Updates CHANGELOG.md: Adds entries for new features and changes
  • Updates API docs: Synchronizes API documentation with contracts
  • Preserves user content: Content outside speckit markers is never modified

Marker System

docs-sync uses HTML comment markers to delineate auto-generated sections:

<!-- speckit:start:section-name -->
Auto-generated content here
<!-- speckit:end:section-name -->

Content outside these markers is preserved exactly as-is.

Output

The skill outputs a DocsSyncResult showing:

  • Files created, updated, or unchanged
  • Sections modified within each file
  • Diff summary (lines added/removed/changed)
  • Any errors encountered

Usage

This skill runs automatically after /speckit.implement. You can also run it manually:

npx skills run docs-sync

Exit Codes

CodeStatusMeaning
0SuccessAll updates successful
1PartialSome updates failed
3ErrorRequired files missing

Sections Updated

README.md
SectionMarkerContent Source
Usage<!-- speckit:start:usage -->spec.md user stories
Installation<!-- speckit:start:installation -->plan.md dependencies
Features<!-- speckit:start:features -->spec.md functional requirements
CHANGELOG.md
SectionMarkerContent Source
Unreleased<!-- speckit:start:unreleased -->tasks.md completed tasks

Preservation Rules

  1. Content before the first marker is always preserved
  2. Content after the last marker is always preserved
  3. Content between different marker pairs is always preserved
  4. Only content within matching marker pairs is updated
  5. If no markers exist, content is appended with new markers

Error Handling

  • Missing markers: Creates new markers and adds content
  • Malformed markers: Reports error, skips that section
  • File permissions: Reports error, continues with other files
  • Missing source files: Reports which sources are unavailable

Comments

Markdown supported