harness-index-docs

Generate or update index.md with grouped, alphabetically sorted links to documentation files.

1|Updated May 23, 2026
One-click install
npx skills add https://github.com/baobao0303/harness --skill harness-index-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: harness-index-docs
Source: https://github.com/baobao0303/harness/tree/main/.agents/skills/harness-index-docs
Command: npx skills add https://github.com/baobao0303/harness --skill harness-index-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill solves the problem of keeping an up-to-date index of documentation files so users and agents can quickly discover what exists in a specific folder.

Core Features & Use Cases

  • Directory scanning: Lists all files and subdirectories in a target folder.
  • Content-informed summaries: Reads each file to generate concise, accurate 3–10 word descriptions.
  • Index creation/update: Writes or refreshes index.md in the target folder with grouped, sorted links.

Quick Start

Ask the AI to generate or update an index.md for the specified target docs folder.

Frequently Asked Questions about harness-index-docs

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

FAQPage Schema
How do I generate a documentation index for a folder?

To generate a documentation index, this Skill scans the target folder recursively, reads documentation files, and writes an index.md with grouped, alphabetically sorted relative links and concise summaries.

What is the best way to maintain a markdown catalog for repository documentation?

Maintaining a markdown catalog is handled by updating the index.md file in the target folder, creating a discoverable and sorted reference of all documentation files with content-informed summaries.

Can I automatically summarize documentation files for a directory listing?

Yes, you can automatically summarize documentation files because the Skill reads each file's content to generate accurate 3–10 word descriptions for the directory listing.

Does the directory indexing process work with nested subdirectories?

The directory indexing process works with nested subdirectories by recursively scanning files and subdirectories within the specified target folder to build a complete documentation catalog.

What happens if the target folder is missing or not writable during index creation?

If the target folder is missing or not writable during index creation, the Skill halts the process to prevent errors and ensure the index.md file is only written to valid locations.