Documentation Sync

Keep repo docs up-to-date with code changes. Update README, docs, and ADRs in the same change.

Sby Skills Guide Bot
DocumentationIntermediate
108/5/2026
Claude CodeCursorWindsurfCopilotCodex
#docs-sync#documentation#adr#decisions#readme

Recommended for


name: docs-sync description: Use when behavior, setup, validation, public wording, data provenance, or workflow commands change and repository documentation may need to be updated.

Docs Sync

  • Check README.md, docs/DECISIONS.md, relevant docs under docs/, and any ADRs.
  • Update docs in the same change as code when public behavior, commands, assumptions, or validation evidence changes.
  • Record durable decisions in docs/DECISIONS.md or a new ADR; do not bury decisions only in chat.
  • Keep docs concise and operational: what changed, why, how to run it, and what remains out of scope.
  • Avoid rewriting unrelated docs or changing historical decisions except to add a dated superseding note.
Related skills