docs-sync

Audits mismatches between code and documentation, producing a prioritized list of fixes with file references.

3.6k|897|Updated May 31, 2025
One-click install
npx skills add https://github.com/openai/openai-agents-js --skill docs-sync-openai
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-sync
Source: https://github.com/openai/openai-agents-js/tree/main/.agents/skills/docs-sync
Command: npx skills add https://github.com/openai/openai-agents-js --skill docs-sync-openai

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Identify gaps and inconsistencies between the repository code and its documentation, focusing on coverage, accuracy, and alignment with main features.

Core Features & Use Cases

  • Inventory features exposed in code and compare to docs to surface coverage gaps.
  • Propose targeted documentation updates and structure changes, ensuring English docs under docs/src/content/docs/** are kept up-to-date.
  • Generate evidence with file paths and symbols to support changes and approvals.
  • Enforce a doc-first workflow that guides reviewers through both code and documentation improvements.

Quick Start

Use the docs-sync workflow on the current branch to audit docs against code and produce a change plan 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 against repository code?

To audit documentation coverage, the Skill compares features exposed in your repository code against your docs to identify gaps and inconsistencies. It produces a structured report with evidence like file paths and symbols, plus suggested edits for approval.

What is the best way to find documentation gaps between a branch and main?

Finding documentation gaps between a branch and main is handled by analyzing the current branch against main, or the diff versus main if not on main. This surfaces inconsistencies in feature alignment, accuracy, and overall documentation coverage.

Can I automatically generate documentation updates for English docs?

You can generate targeted documentation updates for English docs located under docs/src/content/docs/**. The Skill proposes structure changes and specific edits based on code analysis, providing file paths and symbols to support the suggested improvements.

Does docs-sync work with openai-agents-js repositories?

Docs-sync works with repositories like openai-agents-js to inventory features exposed in code and compare them to existing documentation. It ensures English documentation accurately reflects the main features and codebase logic.

How do I enforce a doc-first workflow during code review?

To enforce a doc-first workflow during code review, the Skill generates a change plan with evidence from file paths and symbols. This guides reviewers through both code and documentation improvements before final approvals.