skills.rest
oldwinter
oldwinterCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

skills-readme-updater

Scan skill directories and extract metadata to regenerate README.md.

5|Updated Jan 19, 2026
Search Tags:#automation#documentation#skills#readme#update#generator
One-click install
npx skills add https://github.com/oldwinter/skills --skill skills-readme-updater
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: skills-readme-updater
Source: https://github.com/oldwinter/skills/tree/main/meta-skills/skills-readme-updater
Command: npx skills add https://github.com/oldwinter/skills --skill skills-readme-updater

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill automates the process of updating the main README.md file for the skills repository, ensuring it accurately reflects the available skills and their categorizations.

Core Features & Use Cases

  • Automated Scanning: Scans all skill directories for SKILL.md files.
  • Metadata Extraction: Parses YAML frontmatter to gather skill names and descriptions.
  • Dynamic README Generation: Rebuilds the README.md with categorized skill lists, directory structure, and usage instructions.
  • Use Case: After adding a new skill or modifying an existing one, this Skill ensures the central README.md is updated automatically, saving manual effort and preventing outdated documentation.

Quick Start

Run the update script to refresh the main README.md file.

Frequently Asked Questions about skills-readme-updater

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

FAQPage Schema
How do I automatically update a README.md file after adding new skills?▼

You can automatically update a README.md by triggering this Skill to scan all skill directories, extract metadata from SKILL.md YAML frontmatter, and rebuild the file with categorized listings and usage instructions.

What is the best way to generate a categorized skills list in markdown?▼

Generating a categorized skills list in markdown is done by parsing SKILL.md files within each directory, extracting their metadata, and organizing the entries into predefined categories to rebuild the README file.

How does metadata extraction from SKILL.md files work for documentation generation?▼

Metadata extraction for documentation generation works by scanning skill directories, parsing the YAML frontmatter in SKILL.md files to gather names and descriptions, and organizing them into predefined categories to regenerate the README.

Do I need specific dependencies to scan directories and update my README file?▼

No specific dependencies are required to scan directories and update your README file. The Skill operates independently using its internal scripts to parse YAML frontmatter and regenerate the markdown listings.

When should I run a script to refresh documentation with skill metadata?▼

You should run a script to refresh documentation with skill metadata whenever you add a new skill, modify an existing SKILL.md file, or need to ensure the central README accurately reflects the current directory structure and categories.

Related Skills

Explore More Software Engineering Skills→
mkgs-databricks-demosmkgs-databricks-demos
1

databricks-mlflow-evaluation

Locate root SKILL.md files and extract YAML frontmatter metadata into YAML documents.

Official
Advanced
yu-iskwyu-iskw
3

Maintain README

Synchronize README.md plugin tables and documentation links from manifests.

Community
Intermediate
lbliiilbliii
41

bengal-content-migration

Migrates static site and Markdown content to Bengal format.

Community
Intermediate
brainbrewlabsbrainbrewlabs
7

doc-publishing

Publishes documentation to GitHub Pages, Vercel, or Netlify from source docs and build outputs.

Official
Intermediate