What problem does it solve?
Documentation often drifts from the actual codebase, creating divergent indices, broken links, and outdated requirements. This Skill automates the alignment of project documentation by syncing the documentation index, functional requirements, and technical docs, and by enforcing a minimal, consistent structure across the repository.
Core Features & Use Cases
- Syncs top-level documentation structure with the codebase to prevent drift.
- Ensures functional specs link to the corresponding technical docs and vice versa.
- Detects and prevents duplication between README, docs/index.md, and category indexes, guiding proper placement.
- Triggered as part of the development workflow after successful code changes to keep documentation in sync and up-to-date.
Quick Start
Run doc-sync after making code changes to refresh the documentation index and ensure cross-references stay accurate.