Docs Sync

Analyze main branch implementation and configuration to find missing, incorrect, or outdated documentation in docs/.

You say
Install this skill Read the source first Free Written by openai · unverified publisher
Context cost
1.7k tokensestimated from the bundle, loaded when it triggers
Bundle
2 files · 6.8 kBtext throughout, nothing executable
Licence
MITfree to use
Last change
no release on file
Servers it uses
Noneruns standalone

What it does

Analyze main branch implementation and configuration to find missing, incorrect, or outdated documentation in docs/. Use when asked to audit doc coverage, sync docs with code, or propose doc updates/structure changes. Only update English docs under docs/** and never touch translated docs under docs/ja, docs/ko, or docs/zh. Provide a report and ask for approval before editing docs.

Installed, it changes the agent in these ways.

What this skill changes about the agent is not written down here yet. The listing was collected from its source, and the description is in its own SKILL.md.

Output format

Produces one artefact, exactly shaped.

contentdocumentation

The skill itself

This is the whole product. A skill is instructions the model reads, so there is nothing behind the listing you cannot see first — the front matter loads with every session, and the body below it loads when the skill triggers.

SKILL.md4.3 kB · 77 lines
--- name: docs-sync description: Analyze main branch implementation and configuration to find missing, incorrect, or outdated documentation in docs/. Use when asked to audit doc coverage, sync docs with code, or propose doc updates/structure changes. Only update English docs under docs/** and never touch translated docs under docs/ja, docs/ko, or docs/zh. Provide a report and ask for approval before editing docs. ---
6# Docs Sync
7
8## Overview
9
10Identify doc coverage gaps and inaccuracies by comparing main branch features and configuration options against the current docs structure, then propose targeted improvements.
11
12## Workflow
13
141. Confirm scope and base branch
15 - Identify the current branch and default branch (usually main).
16 - Prefer analyzing the current branch to keep work aligned with in-flight changes.
17 - If the current branch is not main, analyze only the diff vs main to scope doc updates.
18 - Avoid switching branches if it would disrupt local changes; use git show main:<path> or git worktree add when needed.
19
202. Build a feature inventory from the selected scope
21 - If on main: inventory the full surface area and review docs comprehensively.
22 - If not on main: inventory only changes vs main (feature additions/changes/removals).
23 - Focus on user-facing behavior: public exports, configuration options, environment variables, CLI commands, default values, and documented runtime behaviors.
24 - Capture evidence for each item (file path + symbol/setting).
25 - Use targeted search to find option types and feature flags (for example: rg "Settings", rg "Config", rg "os.environ", rg "OPENAI_").
26 - When the topic involves OpenAI platform features, invoke $openai-knowledge to pull current details from the OpenAI Developer Docs MCP server instead of guessing, while treating the SDK source code as the source of truth when discrepancies appear.
27
283. Doc-first pass: review existing pages
29 - Walk each relevant page under docs/ (excluding docs/ja, docs/ko, and docs/zh).
30 - Identify missing mentions of important, supported options (opt-in flags, env vars), customization points, or new features from src/agents/ and examples/.
31 - Propose additions where users would reasonably expect to find them on that page.
32
334. Code-first pass: map features to docs
34 - Review the current docs information architecture under docs/ and mkdocs.yml.
35 - Determine the best page/section for each feature based on existing patterns and the API reference structure under docs/ref.
36 - Identify features that lack any doc page or have a page but no corresponding content.
37 - Note when a structural adjustment would improve discoverability.
38 - When improving docs/ref/* pages, treat the corresponding docstrings/comments in src/ as the source of truth. Prefer updating those code comments so regenerated reference docs stay correct, instead of hand-editing the generated pages.
39
405. Detect gaps and inaccuracies
41 - **Missing**: features/configs present in main but absent in docs.
42 - **Incorrect/outdated**: names, defaults, or behaviors that diverge from main.
43 - **Structural issues** (optional): pages overloaded, missing overviews, or mis-grouped topics.
44
456. Produce a Docs Sync Report and ask for approval
46 - Provide a clear report with evidence, suggested doc locations, and proposed edits.
47 - Ask the user whether to proceed with doc updates.
48
497. If approved, apply changes (English only)
50 - Edit only English docs in docs/**.
51 - Do **not** edit docs/ja, docs/ko, or docs/zh.
52 - Keep changes aligned with the existing docs style and navigation.
53 - Update mkdocs.yml when adding or renaming pages.
54 - Build docs with make build-docs after edits to verify the docs site still builds.
55
56## Output format
57
58Use this template when reporting findings:
59
60Docs Sync Report
61
62- Doc-first findings
63 - Page + missing content -> evidence + suggested insertion point
64- Code-first gaps
65 - Feature + evidence -> suggested doc page/section (or missing page)
66- Incorrect or outdated docs
67 - Doc file + issue + correct info + evidence
68- Structural suggestions (optional)
69 - Proposed change + rationale
70- Proposed edits
71 - Doc file -> concise change summary
72- Questions for the user
73
74## References
75
76- references/doc-coverage-checklist.md
77
In the file
SKILL.md637 words
Files2
LicenceMIT
Why you can read it

Nothing in a skill executes. The client loads the text and the model follows it, so a skill can be audited the way a runbook is — by reading it.

What it costs in context

Skills are not billed by the call. They are paid for in context: every token the instructions occupy is a token your code, your diff and your conversation cannot use. Here is what this one takes and when it takes it.

≈110
always loaded
The name and description, so the model knows the skill exists and when to reach for it.
1,590
on trigger
The instruction body and 1 supporting file, read only when the skill fires.
0.85%
of a 200k window
Ten skills this size would take about 9% of the window before you open a file.
050k100k150k200k context window

1.7k tokens, estimated from the bundle at four bytes to the token, held for the rest of the session once it triggers. Middling. Fine to keep on in a project where you use it weekly, worth unloading in one where you never do.

Servers bill, skills cost

A server charges by the month. A skill charges once per session, in context, and then keeps charging it for as long as the session lives.

Before and after

The same question, put to the same model twice: once as it comes, and once with these instructions loaded.

No worked example has been published for this skill yet.

Adoption
Installsnone yet
Ratingno reviews yet

The procedure it runs

The procedure has not been published here. It is in the skill’s own SKILL.md, which its author has not sent to the marketplace yet.

Prose, not code

These steps are written for a model to follow, not executed by a runtime. It can still be told to skip one, and it will say so when it does.

Servers it uses

None. This skill calls no MCP servers at all.

Everything it needs is in the instructions, so it works in a project with nothing connected — the model reads the file and changes how it works with what it can already reach.

It writes no files and reaches no network. All it changes is how the model reasons and writes.

What it asks for
Writes filesno
Network accessno

Read from the allowed-tools line of this skill’s own SKILL.md. A skill grants no permissions of its own — it can only ask for tools your client already has.

What it will not do

Every skill is narrow, and the useful ones say where they stop. These are the jobs this one is the wrong tool for.

What this skill is not for has not been published here. Nothing is implied by that: it is a section the author has not filled in.

What is in the bundle

2 files, 6.8 kB on disk. A bundle is text throughout: the instructions the model reads, plus the templates it fills in.

  • SKILL.md4.3 kB
  • references/doc-coverage-checklist.md2.5 kB
What is not in it

No dependencies and nothing executable: a skill is text the agent reads, so the bundle is 2 files you can review in full before installing. The MIT licence covers the templates and examples as well as the instructions.

Install

Installing copies the bundle into your project. Nothing runs at install time — the files sit on disk until the model reads them.

# Docs Sync · 1.7k tokens when loaded npx mcprush@latest skill add openai/docs-sync

Writes to .claude/skills/docs-sync/ in the current project. Add --global to put it in your home directory instead, for every project.

Which clients pick it up on their own

A skill is a folder of text. A client with a skills folder reads it without being told; everywhere else the same text works, it is just handed to the model rather than found.

Claude Code.claude/skills/
Claude Desktop
ChatGPT
Cursor.cursor/skills/
VS Code.github/skills/
Codex CLI.agents/skills/
Gemini CLI.gemini/skills/
Grok.grok/skills/
Zed.agents/skills/
Windsurf.windsurf/skills/
Agent SDK.claude/skills/
HTTP / API
This release
Versionnot versioned
Publishedno release date on file
PriceFree
Referenceopenai/docs-sync

Versions

Its author publishes no version number, so there is nothing here to pin to: what you install is the folder as it stands today. Instructions change more often than APIs do — a skill can be rewritten entirely without anything it depends on moving.

v
  • No earlier releases have been published to the marketplace.
Pinning

Nothing to pin to: this skill carries no version number of its own. What you install is what the folder holds on the day you install it.

Reviews

no reviews yet · no installs yet

Nobody has reviewed this skill yet. The rating is the mean of the reviews written here, so there is none until somebody writes the first.

Who can post

Only accounts that have had the skill installed for fourteen days, so a review is written after living with it rather than after reading it. Publishers may reply once.

Who wrote it

OP
openai

Publishes on mcprush.

0 servers listed2 skills listednot claimed
Profile
Publisher
Servers0
Claim this skill