doc-sync

To keep documentation in sync with code changes, you can automate the synchronization of project files like PROGRESS.md, README.md, and HANDOFF.md to match the current codebase state. This prevents outdated information and improves project understanding.

To detect inconsistencies between code and documentation, run an automated consistency check that identifies and reports mismatches. It flags issues like TODOs in code missing from PROGRESS.md or removed features still documented in the docs/ directory.

The best way to update README and docs files before a release is to run an automated documentation synchronization process. It updates all project documentation to match code changes, ensuring accuracy and consistency across the codebase.

Yes, you can automatically update PROGRESS.md and HANDOFF.md to reflect new API endpoints. The documentation sync process updates relevant sections in these files and the docs/ directory to match the current codebase state.

Yes, documentation sync works without external dependencies. The skill operates independently using internal scripts and references to detect code and documentation inconsistencies and update project files to match codebase changes.

You should run a documentation consistency check after implementing code changes and before releases. This ensures that updates to features, API endpoints, and TODOs are accurately reflected in README.md, PROGRESS.md, and the docs/ directory.