doc-sync

Syncs doc/index.yml with doc/guide.list.directory.md and updates from Markdown files.

Updated Mar 30, 2026
One-click install
npx skills add https://github.com/MiDouTech/myTapd --skill doc-sync-midoutech
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-sync
Source: https://github.com/MiDouTech/myTapd/tree/main/.claude/skills/doc-sync
Command: npx skills add https://github.com/MiDouTech/myTapd --skill doc-sync-midoutech

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Synchronizes the documentation index by scanning the doc/ directory and aligning doc/index.yml with doc/guide.list.directory.md, ensuring entries reflect current markdown files and reducing drift between the authoritative index and the rendered guide view.

Core Features & Use Cases

  • Bidirectional synchronization between index.yml and guide.list.directory.md to keep metadata consistent with the actual files.
  • Automatic title updates by reading the first heading from each markdown file or falling back to the filename when a heading is missing.
  • Non-destructive handling of deletions: missing files are flagged for review rather than auto-deleted, enabling safe cleanup.
  • Use Case: when new docs are added to doc/ by team members, run the sync to update the index and render view in one step.

Quick Start

Run the /doc-sync command to perform a full synchronization of the documentation index.

Frequently Asked Questions about doc-sync

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

FAQPage Schema
How do I automatically synchronize my markdown documentation index?

To synchronize your markdown documentation index, run the /doc-sync command. It scans the doc/ directory, aligns index.yml with guide.list.directory.md, and updates entries from current markdown files to reduce metadata drift.

What is the best way to keep index.yml and a generated markdown guide view consistent?

Keeping index.yml and a generated markdown guide view consistent requires enforcing index.yml as the authoritative source. The synchronization process automatically generates guide.list.directory.md from index.yml to ensure both match.

How are missing markdown files handled during documentation index synchronization?

During documentation index synchronization, missing markdown files are flagged for review rather than automatically deleted. This non-destructive handling ensures safe cleanup and prevents accidental data loss when files are moved or removed.

How are document titles extracted when synchronizing a documentation index?

When synchronizing a documentation index, document titles are automatically extracted by reading the first heading from each markdown file. If a heading is missing, the system falls back to using the filename as the title.

Can I trigger documentation index synchronization automatically on a schedule?

You can trigger documentation index synchronization automatically through weekly reports. The system applies changes to doc metadata and its rendered view without requiring manual invocation of the /doc-sync command.