docs-sync

Documentation gap detection works by cross-referencing source code implementation against existing documentation assets like top-level READMEs, per-package READMEs, and dedicated docs directories to identify missing, outdated, or incorrect content for features and configuration options.

Yes, you can detect missing documentation for new configuration options by comparing the current branch implementation against existing docs. This flags missing docs for new commands, client behaviors, and renamed options that exist in the code but lack documentation coverage.

The best way to check for code-doc alignment before a release is to perform a pre-release audit that cross-references the master branch implementation against existing documentation assets. This identifies outdated default values, removed features, and incorrect command behaviors to ensure docs match the implementation.

Yes, documentation maintenance works for per-package READMEs and top-level docs. The process applies to repositories with structured documentation sets, auditing dedicated docs directories and README files to ensure project documentation stays perfectly aligned with codebase changes.

A documentation audit can catch inaccuracies such as outdated default values, removed features, renamed configuration options, and missing documentation for new commands or client behaviors by cross-referencing the actual source code implementation against existing documentation assets.

You should run a documentation gap detection workflow during ongoing maintenance, post-feature doc updates, and pre-release audits. Running it against the current branch diff or master branch implementation ensures documentation stays aligned with continuous codebase changes.