doc-sync

Synchronize doc/ metadata between index.yml and guide.list.directory.md.

2|1|Updated Dec 10, 2025
One-click install
npx skills add https://github.com/inernoro/prd_agent --skill doc-sync-inernoro
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-sync
Source: https://github.com/inernoro/prd_agent/tree/main/.claude/skills/doc-sync
Command: npx skills add https://github.com/inernoro/prd_agent --skill doc-sync-inernoro

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Document indexing and consistency across doc/ assets can drift, causing mismatches between index.yml and guide.list.directory.md. Doc-sync automatically aligns metadata and renders the views, reducing manual maintenance.

Core Features & Use Cases

  • Bi-directional synchronization between doc/index.yml and guide.list.directory.md, ensuring consistent titles and entries.
  • Automatic detection of new, updated, or missing files; reads the first line as title when present; preserves human-added notes where necessary.
  • Manual trigger via /doc-sync and silent invocation by weekly reports for automated workflows.

Quick Start

Trigger /doc-sync to synchronize the doc index with the directory listing.

Frequently Asked Questions about doc-sync

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

FAQPage Schema
How do I automatically sync markdown document indexes?

To automatically sync markdown document indexes, you can trigger the synchronization process to align your doc/ directory with index.yml and guide.list.directory.md, ensuring metadata consistency without manual updates.

What is the best way to maintain consistency between index.yml and directory listings?

Maintaining consistency between index.yml and directory listings requires bi-directional synchronization that automatically detects new, updated, or missing Markdown files and aligns their metadata entries.

How does document indexing handle missing or deleted Markdown files?

Document indexing handles missing or deleted Markdown files through non-destructive deletion handling, preserving authoritative index data while logging all synchronization changes for traceability.

How do I extract titles from Markdown files for index synchronization?

To extract titles for index synchronization, the system reads the first header line of the Markdown file as the title, applying specific handling for non-conforming file prefixes to ensure accurate metadata.

Can I automate documentation index updates for weekly reports?

You can automate documentation index updates for weekly reports through silent invocation, allowing the synchronization workflow to run automatically in the background alongside manual trigger capabilities.