skills.rest
reeinharddd
reeinhardddCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

doc-index-update

Update README.md index files from Markdown frontmatter metadata.

Updated Aug 23, 2026
Search Tags:#automation#documentation#content management#indexing#git workflow#readme
One-click install
npx skills add https://github.com/reeinharddd/impulsa-monorepo --skill doc-index-update
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-index-update
Source: https://github.com/reeinharddd/impulsa-monorepo/tree/main/.github/skills/doc-index-update
Command: npx skills add https://github.com/reeinharddd/impulsa-monorepo --skill doc-index-update

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill ensures that your documentation is always up-to-date by automatically maintaining tables of contents and index files whenever documentation changes.

Core Features & Use Cases

  • Automatic Indexing: Updates README.md files in specified directories when documentation is added, removed, or renamed.
  • Metadata Extraction: Parses frontmatter from Markdown files to populate index tables with document type, status, and description.
  • Use Case: After adding a new technical design document to docs/technical/backend/, this Skill will automatically add an entry for it in the docs/technical/backend/README.md file, ensuring discoverability.

Quick Start

Run the doc-index-update skill to update all documentation indexes.

Frequently Asked Questions about doc-index-update

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

FAQPage Schema
How do I automatically update a table of contents in README files when Markdown documentation changes?▼

Automatic indexing updates README.md files by detecting file creation, deletion, and renaming events within your docs directory, then rewriting the index entries to match the current file structure.

How does metadata extraction from Markdown frontmatter populate documentation indexes?▼

Metadata extraction parses Markdown frontmatter to retrieve document type, status, and description fields, using this extracted information to populate the corresponding columns in the generated index tables.

Can I use this documentation indexing workflow with my existing Git workflow?▼

Yes, the documentation indexing workflow integrates with standard Git workflows by operating directly on your local docs directory, processing Markdown files, and updating README.md indexes without requiring external dependencies.

What is the best way to ensure all technical design documents are listed and discoverable in docs directories?▼

The best way to ensure discoverability is to maintain automated index files that validate links and list every document, automatically adding entries whenever a new Markdown file is added to the directory.

Does this documentation indexing process validate links inside the generated README index files?▼

Yes, the documentation indexing process validates links within the README.md files to ensure all listed documentation entries are accessible and correctly referenced in the index tables.

Related Skills

Explore More Software Engineering Skills→
p-iknowp-iknow
1

doc-frontmatter

Generate and validate YAML frontmatter for Markdown documentation files.

Community
Intermediate
Wolfe-JamWolfe-Jam
4

faf-git

Configures Git workflows for committing FAF context files and .gitignore rules.

Community
Basic
akiselevakiselev
1

doc-sync

Audit and synchronize CLAUDE.md indexes with README.md across repositories or specified directories.

Community
Advanced
zzafergokzzafergok
1

markdown-to-html-skill

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

Community
Intermediate