docs-sync

Compare branch features against English docs and generate a gap report.

Updated Aug 23, 2026

Search Tags:#documentation #audit #report #docs-sync #branch-diff #english-docs #doc-coverage

Ready to run

npx skills add https://github.com/redacharf/fin-punk --skill docs-sync-redacharf

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: docs-sync
Source: https://github.com/redacharf/fin-punk/tree/main/.agents/skills/docs-sync
Command: npx skills add https://github.com/redacharf/fin-punk --skill docs-sync-redacharf

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Identify gaps between main branch features and documentation in docs/ and propose targeted English updates to improve coverage.

Core Features & Use Cases

Compare code features and configuration against docs structure to surface missing mentions of options, env vars, or behavior.
Generate a structured Docs Sync Report with evidence (file path + symbol/setting) and suggested edits for English pages under docs/src/content/docs/**.
Propose minimal, navigable edits and file new pages only when necessary; output a patch-ready summary and request approval before applying changes.

Quick Start

Audit the current branch docs against main and generate a report of gaps with suggested English-only updates.

Frequently Asked Questions about docs-sync

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

FAQPage Schema

How do I find missing documentation for new features on my main branch?▼

To find missing documentation, audit your current branch against main to identify undocumented options, env vars, or behavior. This generates a structured report with evidence and patch-ready English edits for docs/src/content/docs/**.

What is a documentation audit and how does it improve doc coverage?▼

A documentation audit compares code features against existing docs structure to surface missing mentions. It captures file paths and symbols as evidence, proposing targeted English updates to close coverage gaps and improve accuracy.

Can I automatically generate English docs updates for my current branch?▼

You can generate patch-ready English docs updates by analyzing your branch against main. The workflow proposes minimal, navigable edits and requests reviewer approval before applying any changes to the pages.

Does the docs audit support updating non-English documentation pages?▼

No, the docs audit explicitly limits changes to English pages under docs/src/content/docs/**. It focuses on generating targeted English updates and does not modify localized or translated documentation.

What's the best way to align documentation with code changes before merging?▼

The best way to align docs with code is running a branch-diff analysis against main. It identifies configuration gaps and outputs a report with suggested edits, ensuring documentation stays synchronized with new features before merging.