sync-docs

To keep API documentation in sync with recent code changes, you can run sync-docs after a PR lands to inspect the diff and apply minimal, in-place edits to existing OpenAPI specs, READMEs, and .env.example files, preventing documentation drift.

The best way to update environment variable examples after a commit is to use a change-aware syncing tool that searches your repository for hand-maintained .env.example files and applies minimal edits to match the latest configuration keys.

Documentation drift detection works by inventorying your repository's doc surfaces, confirming they are hand-maintained rather than generated outputs, and then applying targeted in-place edits only to stable identifiers and manual files.

Yes, you can update Swagger specs in place after renaming a route because the syncing process preserves stable identifiers in OpenAPI specs and edits existing documentation files directly rather than creating new ones.

No, sync-docs does not create new documentation files; it strictly edits existing hand-maintained files like developer guides and ADR notes, and will only report gaps when it finds missing coverage for updated dependencies or behaviors.

You need to manually update documentation when you want to create new doc files or modify generated outputs, whereas automated syncing is designed strictly for applying minimal, in-place edits to existing, hand-maintained documentation surfaces.