Which programming languages are supported?

It features built-in detection and support for JavaScript, Python, Rust, and Go projects, but its regex-based fallback works for most text-based source code.

What is a repo-map and do I need it?

A repo-map uses ast-grep to create an index of code symbols. While not strictly required, it significantly improves the accuracy of detecting undocumented exports.

How does sync-docs find related documentation?

It analyzes git diffs and uses grep to find references to changed files, function names, and classes within your project's markdown files, ensuring the right docs are checked.

Does this skill automatically modify my files?

No, it operates in 'report' mode by default, providing structured data and fix suggestions. You must explicitly use 'apply' mode or approve the changes recommended by the orchestrator.

Can it update my CHANGELOG?

Yes, it checks for an [Unreleased] section and compares recent commit messages to existing entries to ensure every change is properly recorded.

Documentation Synchronizer

Name: Documentation Synchronizer
Author: avifenesh

byavifenesh

•

311

学习与文档

Synchronizes project documentation and changelogs with current code state to prevent stale or inaccurate technical information.

关于

The sync-docs skill is a comprehensive utility for maintaining documentation integrity by automatically identifying discrepancies between source code and markdown files. It analyzes Git diffs to find related documentation, detects outdated code examples, flags version mismatches against package manifests, and ensures the CHANGELOG stays current with recent commits. By integrating with repo-maps and leveraging AST-based symbol detection, it identifies undocumented exports and provides structured fix suggestions, making it an essential tool for developers who want to automate the tedious aspects of documentation maintenance.

主要功能

Automated detection of stale documentation based on recent Git history
Validation of code examples and import paths within documentation
Version mismatch verification between package manifests and README files
Identification of undocumented exports using AST-based repository maps
Automated CHANGELOG audits for unreleased changes and commit parity
311 GitHub stars

使用场景

Updating documentation automatically after a major refactor or API change
Ensuring the CHANGELOG accurately reflects all commits before submitting a Pull Request
Auditing large repositories to find public exports that lack documentation

关于

主要功能

Automated detection of stale documentation based on recent Git history
Validation of code examples and import paths within documentation
Version mismatch verification between package manifests and README files
Identification of undocumented exports using AST-based repository maps
Automated CHANGELOG audits for unreleased changes and commit parity
311 GitHub stars

使用场景

Updating documentation automatically after a major refactor or API change
Ensuring the CHANGELOG accurately reflects all commits before submitting a Pull Request
Auditing large repositories to find public exports that lack documentation