docs-sync

/speckit.implement

Purpose

• 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

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

Output

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

Usage

/speckit.implement

npx skills run docs-sync

Exit Codes

Sections Updated

README.md

<!-- speckit:start:usage -->

<!-- speckit:start:installation -->

<!-- speckit:start:features -->

CHANGELOG.md

<!-- speckit:start:unreleased -->

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