docs-sync

Audit repository documentation against main branch features and propose edits.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/filipesf/dotfiles --skill docs-sync-filipesf
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-sync
Source: https://github.com/filipesf/dotfiles/tree/main/agents/skills/docs-sync
Command: npx skills add https://github.com/filipesf/dotfiles --skill docs-sync-filipesf

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps identify gaps and inconsistencies between code features and user-facing documentation by auditing the main branch against the existing docs structure, focusing on English docs under docs/src/content/docs and excluding translations.

Core Features & Use Cases

  • Doc-coverage audit: detect missing or outdated mentions of options, env vars, and feature behaviors across docs.
  • Cross-reference mapping: align code features with the most relevant docs pages and suggest structural improvements.
  • Docs Sync reporting: generate a clear report with evidence, suggested edits, and an approval step before making changes.

Quick Start

Run the docs-sync process on your repository to produce a report showing gaps and proposed edits for English docs under docs/src/content/docs. Review the report and approve edits before applying changes.

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 against my main branch to find outdated content?

You can audit documentation against your main branch by running the docs-sync process to compare current docs with repository features. It identifies missing, incorrect, or outdated content and generates a report with proposed edits for English docs under docs/src/content/docs.

What is documentation drift and how do I detect missing configuration options in my docs?

Documentation drift happens when code features change without updating user-facing docs. Detect missing configuration options, environment variables, and feature behaviors by running an automated audit that cross-references main branch exports against your existing documentation structure.

Does the docs-sync audit require approval before modifying repository documentation?

Yes, the docs-sync audit requires approval before modifying repository documentation. It generates a clear report with evidence and suggested structural changes, ensuring you review and approve all focused edits before any changes are applied to your English documentation files.

Can I use this documentation audit for translated content and non-English docs?

No, you cannot use this documentation audit for translated content. The process specifically targets English docs located under docs/src/content/docs and explicitly excludes translations, focusing only on aligning public exports, configuration options, and usage guidelines for English documentation.

What's the best way to align code features with relevant docs pages during a git repository audit?

The best way to align code features with relevant docs pages is to use cross-reference mapping during your repository audit. This approach maps main branch features to the most appropriate documentation pages and suggests structural improvements to maintain doc accuracy.