docs-sync

Audit documentation coverage and generate a structured Docs Sync Report.

Updated Dec 6, 2016
One-click install
npx skills add https://github.com/majunbao/learn --skill docs-sync-majunbao
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-sync
Source: https://github.com/majunbao/learn/tree/main/openai-agents-python_tags/openai-agents-python-0.14.6/.agents/skills/docs-sync
Command: npx skills add https://github.com/majunbao/learn --skill docs-sync-majunbao

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Documentation often drifts from code; this skill audits current docs to identify gaps, inaccuracies, and outdated information by comparing the main branch features and configuration against the docs structure, enabling targeted updates.

Core Features & Use Cases

  • Doc coverage audit: compare code/config to docs to surface missing mentions of options, env vars, and behavior.
  • Code-to-doc mapping: align features in src/ with docs pages and propose targeted edits.
  • Review workflow: generate a structured Docs Sync Report for reviewer approval before edits.

Quick Start

Run a docs-sync pass against the current branch to audit English docs, propose targeted updates, and generate a review report for approval.

Frequently Asked Questions about docs-sync

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

FAQPage Schema
How do I audit documentation coverage for gaps and outdated information?

Documentation coverage auditing compares code and configuration files against the docs/ directory to surface missing mentions of options, environment variables, and behavioral changes. This process identifies gaps and outdated information by mapping src/ features to existing documentation pages.

How do I align new code features with existing documentation pages?

Code-to-doc mapping requires diffing the current development branch against main. The system analyzes changes, maps new or changed features to relevant documentation pages, and proposes targeted edits with evidence and cross-links for reviewer approval.

Can I audit English-language docs under the docs/** directory?

Yes, English-language docs under docs/** are supported. The audit compares main branch features and configuration against the documentation structure to identify missing mentions of options, environment variables, and behavior.

What is the best way to generate a structured documentation review report?

The best way is running a docs-sync pass against the current branch. This produces a Docs Sync Report containing evidence, suggested edits, and cross-links designed for reviewer approval before any changes are applied.

Does docs-sync work with MkDocs documentation structures?

Yes, docs-sync audits MkDocs documentation structures by comparing code and configuration against the docs directory. It surfaces missing mentions of options and behavior, proposing targeted updates to align documentation with current source code features.