docs-sync

Audit documentation coverage by comparing code implementation against docs and propose targeted updates.

Updated May 23, 2026
One-click install
npx skills add https://github.com/kiranimmadi2/promptforge-ai --skill docs-sync-kiranimmadi2
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-sync
Source: https://github.com/kiranimmadi2/promptforge-ai/tree/main/openai-agents-python/.agents/skills/docs-sync
Command: npx skills add https://github.com/kiranimmadi2/promptforge-ai --skill docs-sync-kiranimmadi2

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Documentation drifts out of sync with code as features ship, leaving users with missing, incorrect, or outdated guides. This Skill systematically compares the main branch implementation against the docs/ directory to find gaps and inaccuracies before they confuse users. ## Core Features & Use Cases - Doc Coverage Audit: Inventories public exports, configuration options, environment variables, and CLI commands, then maps each to existing documentation pages. - Gap and Inaccuracy Detection: Identifies missing features, outdated defaults, renamed settings, and structural issues in the docs information architecture. - Approval-Gated Editing: Produces a structured Docs Sync Report with evidence and proposed edits, then applies English-only changes to docs/** after user approval, leaving translated docs untouched. - Use Case: Before a release, run the audit on your feature branch diff versus main to confirm every new configuration option and behavior change is documented, then apply the approved updates and verify the site builds with make build-docs. ## Quick Start Use the docs-sync skill to audit the current branch against docs/ and propose targeted documentation updates.

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 my codebase?

Run a docs sync audit that inventories public exports, configuration options, environment variables, and CLI commands from the source code, then maps each item to existing documentation pages. The result is a report listing missing features, outdated defaults, and suggested doc locations.

How to keep docs in sync with code changes on a feature branch?

Analyze only the diff between your branch and main using git diff to scope the review to changed behavior such as new exports, modified defaults, or removed settings. This keeps the audit focused on what actually needs documentation updates.

Does the docs audit modify translated documentation?

No, the audit only edits English documentation under docs/** and explicitly excludes translated directories such as docs/ja, docs/ko, and docs/zh. Translations are left untouched regardless of findings.

Can the skill edit docs without my approval?

No, it first produces a Docs Sync Report with evidence, suggested insertion points, and proposed edits, then asks for approval. Changes are applied only after you confirm, and the docs site is rebuilt with make build-docs to verify.

What are the limitations of automated doc coverage audits?

The audit detects mismatches between code and docs but relies on the source code as the source of truth, so it cannot judge writing quality or user comprehension. Structural suggestions like page reorganization are optional and require human judgment.