Why is dynamic scanning better than a manual file list?

Manual lists become outdated as soon as a file is renamed or moved. Dynamic scanning ensures your documentation index is a real-time mirror of your actual file structure.

How does the skill handle new files in the docs folder?

It scans the directory, identifies the new file, categorizes it based on naming patterns (e.g., SETUP.md or modules/), and adds it to the appropriate section in README.md and CLAUDE.md.

Does this skill work with CLAUDE.md specifically?

Yes, it is designed to maintain a high-priority 'Documentation Index' table in CLAUDE.md to help AI assistants navigate your codebase more efficiently.

Can I use this for non-standard file structures?

While optimized for a 'docs/' directory, the skill uses pattern-based classification that can be adapted to recognize various organizational structures.

Documentation Index Sync

Name: Documentation Index Sync
Author: maxlogvn

bymaxlogvn

0•

学习与文档

Synchronizes README.md and CLAUDE.md documentation indexes automatically by dynamically scanning the docs directory.

The Documentation Index Sync skill ensures that your project's main entry points always reflect the actual state of your documentation. Instead of relying on manually maintained, error-prone lists, this skill implements a dynamic workflow that scans the filesystem, detects missing or orphaned references, and intelligently categorizes Markdown files into logical sections such as Getting Started, Development, and Operations. It is essential for teams who frequently update their docs and want to maintain a reliable 'Source of Truth' for both human developers and AI assistants like Claude.

主要功能

01Dynamic directory scanning to eliminate stale hardcoded file lists

020 GitHub stars

03Standardized link text and description generation based on filenames

04Verification checklist to ensure count consistency across all index files

05Pattern-based classification for automatic grouping into sections

06Automated diff detection between physical files and index references

使用场景

01Reorganizing a complex documentation directory without breaking manual links

02Automating the maintenance of CLAUDE.md for better AI context discovery

03Ensuring new contributors always find the most up-to-date setup and coding guides

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add maxlogvn/aicmr doc-index

For use in Claude.ai and ChatGPT

Download Skill