docs-sync

Name: docs-sync
Availability: InStock
Author: zaziedlm

Analyze main branch code and configuration to identify missing or outdated English documentation.

Updated Jan 17, 2026

Search Tags:#documentation #technical writing #code sync #code audit #documentation updates #doc coverage

Ready to run

npx skills add https://github.com/zaziedlm/openai-agents-python --skill docs-sync-zaziedlm

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: docs-sync
Source: https://github.com/zaziedlm/openai-agents-python/tree/main/.codex/skills/docs-sync
Command: npx skills add https://github.com/zaziedlm/openai-agents-python --skill docs-sync-zaziedlm

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill ensures that your project's documentation accurately reflects its current codebase, preventing outdated or missing information.

Core Features & Use Cases

Documentation Auditing: Compares code changes against existing documentation to identify gaps and inaccuracies.
Content Gap Analysis: Pinpoints features, configurations, or behaviors present in the code but missing from the docs.
Accuracy Verification: Detects and flags discrepancies between code implementation and documented details.
Use Case: After adding a new configuration option to your application, use this Skill to verify that it's correctly documented in the docs/ directory and propose updates if necessary.

Quick Start

Run the docs-sync skill to audit documentation coverage for the main branch.

Frequently Asked Questions about docs-sync

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I check if my documentation is outdated compared to my codebase?▼

Documentation auditing compares your main branch implementation against existing docs to identify missing, incorrect, or outdated information. It analyzes configuration and code to pinpoint gaps, then provides a sync report for approval before editing.

What is the best way to sync English documentation with new code configurations?▼

To sync English documentation with code, run an audit on your main branch to analyze implementation changes. The process identifies features missing from the docs/ directory and proposes updates, explicitly excluding translated versions from the coverage check.

Does documentation syncing automatically edit files in the docs directory?▼

Documentation syncing does not automatically edit files. It analyzes your codebase to find discrepancies and generates a report of missing or incorrect information, requiring your approval before making any edits to the docs/ directory.

Can I use a code audit to find missing features in my technical writing?▼

Yes, a code audit performs content gap analysis by pinpointing features, configurations, or behaviors present in the code but missing from your documentation. It verifies accuracy by flagging discrepancies between implementation and documented details.

Will the docs-sync audit check translated versions of my documentation?▼

The documentation audit focuses exclusively on syncing English documentation and explicitly excludes translated versions. It analyzes the main branch implementation and configuration to verify coverage and accuracy only for the primary English docs/ directory.