rcode-index-docs

Generate and update index.md files for documentation folders with relative links.

2|1|Updated Apr 10, 2026
One-click install
npx skills add https://github.com/hanzlahabib/rcode --skill rcode-index-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: rcode-index-docs
Source: https://github.com/hanzlahabib/rcode/tree/main/rcode/skills/core/rcode-index-docs
Command: npx skills add https://github.com/hanzlahabib/rcode --skill rcode-index-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill removes the manual work of cataloging documentation folders by generating a clean index.md that points to every relevant file and subdirectory.

Core Features & Use Cases

  • Directory Scanning: Reads the target folder structure and identifies files and nested subfolders.
  • Content-Aware Descriptions: Summarizes each document using brief descriptions based on actual file contents rather than filenames alone.
  • Structured Index Creation: Produces an organized index.md with relative links, grouped sections, and alphabetical ordering.
  • Use Case: Use it when a docs folder grows large and you want a navigable table of contents for contributors, readers, or AI workflows.

Quick Start

Ask the skill to create or update an index.md for the target documentation folder.

Frequently Asked Questions about rcode-index-docs

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

FAQPage Schema
How do I generate an index.md file for a large documentation folder?

Generating a directory index.md involves scanning folder structures and creating relative links for all files. This process organizes scattered documentation into a structured, navigable table of contents grouped by location or type.

How does content-aware documentation indexing work?

Content-aware indexing reads actual file contents to summarize each document, rather than relying on filenames alone. This creates an organized index.md with meaningful file descriptions, grouped sections, and alphabetical ordering for better navigation.

Can I automatically organize nested documentation directories into a table of contents?

Yes, you can automatically organize nested directories by scanning the target folder structure. The system identifies files and subfolders, producing an index.md that points to every relevant document using relative links for contributors and readers.

Does directory index generation skip hidden files in the repository?

Directory index generation skips hidden files by default to keep the documentation folder clean. You must explicitly request their inclusion if you need hidden files cataloged within your generated index.md navigation listings.

What is the best way to update index pages when docs files change?

The best way to update index pages when docs change is to regenerate the index.md for the target folder. This updates relative links, groupings, and content-aware descriptions to reflect the current directory structure and file contents.