skills.rest
maxlogvn
maxlogvnCOMMUNITY
Explore all skills by this author →
GitHub

doc-index

Scan docs/ and update CLAUDE.md and README.md indexes.

Updated Aug 27, 2026
Search Tags:#automation#documentation#indexing#claude#readme#docs
One-click install
npx skills add https://github.com/maxlogvn/AiCMR --skill doc-index
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-index
Source: https://github.com/maxlogvn/AiCMR/tree/main/.claude/skills/doc-index
Command: npx skills add https://github.com/maxlogvn/AiCMR --skill doc-index

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps teams keep the README.md and CLAUDE.md documentation indexes synchronized with the actual content under docs/, preventing drift and manual rework.

Core Features & Use Cases

  • Dynamic discovery: scans the docs/ folder to detect all current markdown documentation files.
  • Automatic indexing: updates CLAUDE.md and README.md to reflect the real structure and file names.
  • Consistency verification: highlights mismatches and proposes fixes to keep docs, CLAUDE.md, and README in alignment.
  • Use Case: When adding or renaming a doc in docs/, run the indexer to refresh all references and ensure navigational integrity.

Quick Start

Run a live scan to regenerate the two indexes based on the current docs/ tree.

Frequently Asked Questions about doc-index

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

FAQPage Schema
How do I automatically sync documentation indexes across README and CLAUDE files?▼

Automatically sync documentation indexes by scanning the docs/ directory to detect added, moved, or removed markdown files, then updating README.md and CLAUDE.md to reflect the actual structure.

What is the best way to keep docs indexes in sync when files change?▼

Keeping docs indexes in sync is best handled by running an automated indexer that dynamically scans the docs/ folder, diffs the current tree, and applies auto-inclusion rules to refresh all navigational references.

How does dynamic discovery work for markdown documentation indexing?▼

Dynamic discovery for markdown documentation indexing works by scanning the docs/ folder to detect all current files, identifying new topics, and proposing fixes for any mismatches between the directory and the indexes.

Can I update CLAUDE.md and README.md indexes automatically for any project?▼

You can update CLAUDE.md and README.md indexes automatically for any project that contains a docs/ folder, ensuring the indexes reflect the real structure and file names without manual rework.

Why does my documentation index drift from the actual docs directory structure?▼

Documentation index drift occurs when files are added, moved, or removed in the docs/ directory without updating references, which this indexer prevents by dynamically scanning and regenerating indexes to match.

Are there limitations to automating docs index synchronization?▼

Automating docs index synchronization is limited to projects utilizing a docs/ folder structure, applying specifically to markdown documentation files and updating only CLAUDE.md and README.md references.

Related Skills

Explore More Content & Communication Skills→
caobingshengcaobingsheng
1

docs-writer

Write and edit Markdown documentation following Gemini CLI project standards.

Community
Intermediate
arisngarisng
5

git-atomic-commit

Group repository changes into atomic conventional commits by file type.

Community
Advanced
zzafergokzzafergok
1

markdown-to-html-skill

Convert Markdown documents to HTML using marked.js, pandoc, gomarkdown, or static site generators.

Community
Intermediate
channgchanng
20

docsify

Generate static documentation websites from markdown files with sidebar navigation.

Community
Basic