How does Docs Sync find missing configuration options?

It uses targeted searches like ripgrep to identify settings, environment variables, and feature flags within the codebase, then compares them against the existing documentation structure.

Is the update process automated?

The analysis is automated, but the skill always provides a detailed Docs Sync Report and requires user approval before applying any changes to the documentation files.

Can Docs Sync update translated documentation?

No, the skill is specifically restricted to updating English documentation and is configured to ignore translated directories such as docs/ja, docs/ko, or docs/zh.

Does it modify source code or just markdown files?

While it primarily updates documentation files, it can also update docstrings and comments in the source code to ensure that generated API references remain accurate.

Docs Sync

Name: Docs Sync
Author: zaziedlm

byzaziedlm

콘텐츠 관리

Synchronizes technical documentation with source code by identifying missing features, outdated configurations, and documentation gaps.

소개

Docs Sync is a specialized developer utility designed to ensure your project's documentation never falls behind its implementation. By performing deep analysis of the source code, configuration files, and environment variables, the skill audits the documentation directory to find inaccuracies or missing content. It employs both doc-first and code-first passes to map features to pages, generates a comprehensive gap report, and can automatically apply updates to English documentation while respecting translation boundaries. It is particularly useful for maintaining accurate API references, CLI manuals, and configuration guides in fast-moving repositories.

주요 기능

Automated inventory of CLI commands, environment variables, and config options
0 GitHub stars
Bi-directional gap analysis between source code and documentation files
Safety-first workflow with detailed reporting and approval-based editing
Integration with OpenAI Developer Docs for accurate platform-specific context
Source-of-truth reconciliation by updating docstrings for reference docs

사용 사례

Auditing documentation coverage before a major production release
Synchronizing documentation with new features during the pull request process
Updating API reference pages by reconciling source code docstrings

소개

주요 기능

Automated inventory of CLI commands, environment variables, and config options
0 GitHub stars
Bi-directional gap analysis between source code and documentation files
Safety-first workflow with detailed reporting and approval-based editing
Integration with OpenAI Developer Docs for accurate platform-specific context
Source-of-truth reconciliation by updating docstrings for reference docs

사용 사례

Auditing documentation coverage before a major production release
Synchronizing documentation with new features during the pull request process
Updating API reference pages by reconciling source code docstrings