skill-doc-sync

Synchronize project markdown files with recent code changes.

28|3|Updated May 10, 2026
One-click install
npx skills add https://github.com/CES-Ltd/Lumi --skill skill-doc-sync
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: skill-doc-sync
Source: https://github.com/CES-Ltd/Lumi/tree/main/resources/seed/octopus/skills/skill-doc-sync
Command: npx skills add https://github.com/CES-Ltd/Lumi --skill skill-doc-sync

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the process of synchronizing and updating project markdown documentation, ensuring consistency across files.

Core Features & Use Cases

  • Documentation Discovery: Finds all markdown files within the project, excluding noise directories.
  • Diff Cross-Referencing: Analyzes recent code changes to identify stale or outdated documentation sections.
  • Automatic Updates & Validation: Corrects factual references, verifies version consistency, and flags narrative sections for review.
  • Use Case: After releasing a new version, automatically update version references in all docs and ensure changelog entries are user-focused.

Quick Start

Run this Skill after code changes to automatically update your project's documentation for accuracy and consistency.

Frequently Asked Questions about skill-doc-sync

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

FAQPage Schema
How do I automatically update markdown documentation to reflect recent code changes?

To update markdown documentation automatically after code changes, this Skill cross-references recent diffs against project markdown files to detect stale references and prepares corrected updates for review and deployment.

What is the best way to keep version numbers and links consistent across all project documentation?

Keeping version numbers and links consistent is achieved by scanning all markdown files to validate key values, flagging outdated references, and aligning factual data to improve discoverability and trust across the project.

How does documentation synchronization detect stale references in markdown files?

Documentation synchronization detects stale references by discovering all markdown files while excluding noise directories, then diff cross-referencing them with recent code changes to identify outdated sections for review.

Can I use this to automatically update version references in docs and changelogs after a release?

Yes, you can use this after releasing a new version to automatically update version references across all documentation files and ensure changelog entries remain accurate and user-focused.

Does this documentation sync tool flag narrative sections for manual review?

Yes, the documentation sync tool validates factual references and version consistency automatically, but flags narrative sections for manual review to prevent unintended content overwrites during deployment.