docs-sync

Audit English documentation in docs/ against code and configuration.

Updated Apr 1, 2026
One-click install
npx skills add https://github.com/jaimedhenriques/finsyt --skill docs-sync-jaimedhenriques
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-sync
Source: https://github.com/jaimedhenriques/finsyt/tree/main/artifacts/platform/.agents/skills/docs-sync
Command: npx skills add https://github.com/jaimedhenriques/finsyt --skill docs-sync-jaimedhenriques

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps you find missing, incorrect, or outdated documentation by comparing the current codebase and configuration against the docs.

Core Features & Use Cases

  • Documentation Audit: Review English docs under docs/ to spot coverage gaps and mismatches with implementation.
  • Code-to-Docs Mapping: Trace public behavior, configuration, and runtime details to the best documentation pages or sections.
  • Safe Update Planning: Recommend precise edits, structural improvements, and page placement while avoiding translated docs.
  • Use Case: A product or engineering team can use this Skill before a release to identify which new features need docs updates and where those updates should live.

Quick Start

Ask the assistant to audit the repository’s English docs against the current main branch and report any missing, incorrect, or outdated coverage before editing anything.

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 codebase to find missing or outdated pages?

Documentation audits compare current code and configuration against existing docs to identify missing, incorrect, or outdated coverage. This process maps public behavior and runtime details to the best documentation sections, requiring evidence-backed findings before any edits.

What is the best way to check documentation coverage before a release?

Documentation coverage reviews trace code changes against the docs/ directory to spot coverage gaps and mismatches with implementation. Teams use this branch-aware audit before releases to identify which new features need updates and where those pages should live.

How do I keep technical documentation aligned with code changes across different branches?

Keeping documentation aligned requires branch-aware doc audits that compare implementation details against existing docs. This approach identifies incorrect or outdated content, recommends precise edits, and proposes structural improvements while maintaining translated-doc boundaries.

Does the documentation audit process modify files directly?

Documentation audits follow an approval-first workflow before any edits. The process recommends precise updates, structural improvements, and page placement based on evidence-backed findings, but requires explicit approval before modifying the documentation.

Can I use this to audit MkDocs configuration and structure?

Auditing MkDocs structure involves comparing configuration against existing documentation to identify missing pages and structural improvements. The process traces configuration details to the best documentation sections and proposes placement updates while avoiding translated docs.

What are the limitations of automated code-to-docs mapping?

Code-to-docs mapping limitations include boundaries on translated documentation, requiring evidence-backed findings for every identified gap. The process focuses exclusively on English docs under docs/ and operates with an approval-first workflow before applying any recommended edits.