docs-sync

To check if your documentation is out of sync with your codebase, analyze the main branch implementation and configuration to identify missing, incorrect, or outdated sections within the docs directory. This process audits user-facing behavior, public exports, and environment variables to propose targeted structural improvements.

The best way to audit a docs directory for missing configuration options is to map features and configurations from the codebase to their corresponding documentation pages. This identifies undocumented user-facing behavior and environment variables, proposing structural changes to enhance coverage and accuracy.

Code-to-doc mapping works for technical writing audits by analyzing main branch implementation to find missing or outdated documentation. It focuses on public exports and configuration options, proposing targeted improvements to ensure technical documentation accurately reflects the current codebase.

Yes, you can use an automated doc audit to find outdated environment variables in your docs. By analyzing the main branch implementation and configuration, it identifies incorrect or missing documentation within the docs directory and suggests where to add missing variables.

You should run a documentation coverage audit on your repository after adding a new configuration option or modifying user-facing behavior. This verifies that the changes are documented correctly and identifies any missing or outdated sections within the docs directory.