What happens if I'm working on a feature branch?

Docs Sync can analyze the diff between your current branch and the main branch, allowing you to document new features as you build them without needing to merge first.

Will it make changes to my files automatically?

No. The skill first generates a detailed 'Docs Sync Report' outlining gaps and proposed edits, then asks for user approval before modifying any files.

Does Docs Sync update translated documentation?

No, the skill is explicitly restricted to updating English documentation under the docs/ directory and will never modify translations such as those in docs/ja, docs/ko, or docs/zh.

How does the skill handle API reference pages?

It treats source code docstrings as the source of truth. Instead of hand-editing generated reference pages, it prefers updating the code comments so that future documentation builds remain accurate.

Can it check for external platform changes?

Yes, when analyzing OpenAI-related features, it can invoke the OpenAI Developer Docs MCP server to pull current platform details and ensure your local documentation matches current requirements.

Docs Sync

Name: Docs Sync
Author: wahmd

bywahmd

0•

学习与文档

Synchronizes technical documentation with the latest codebase implementation to ensure accuracy and completeness across the project.

Docs Sync is a specialized skill designed to automate the maintenance of project documentation by auditing codebase changes against existing markdown files. It identifies missing features, outdated configuration options, and undocumented environment variables by comparing the current branch or main branch implementation with the documentation structure. By bridging the gap between development and documentation, it helps maintain high-quality technical resources, providing detailed gap reports and proposing targeted improvements before applying changes, specifically focusing on English-language documentation to maintain global consistency.

主要功能

01Structured reporting that requires user approval before modifying any documentation files

020 GitHub stars

03Automated gap analysis between source code implementation and documentation coverage

04Integration with OpenAI Developer Docs via MCP for accurate platform-specific information

05Docstring-to-reference mapping to ensure API documentation remains the source of truth

06Smart detection of missing environment variables, CLI commands, and configuration options

使用场景

01Auditing doc coverage after major feature releases to identify missing configuration guides

02Syncing API reference documentation with updated docstrings in the source code

03Performing structural audits to improve documentation discoverability and information architecture

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add wahmd/openai-agents-python docs-sync

For use in Claude.ai and ChatGPT

Download Skill