Skip to content

Generate README skill inventory from frontmatter#8

Open
robinandeer wants to merge 1 commit intomainfrom
robin/generate-readme-inventory
Open

Generate README skill inventory from frontmatter#8
robinandeer wants to merge 1 commit intomainfrom
robin/generate-readme-inventory

Conversation

@robinandeer
Copy link
Copy Markdown
Collaborator

Problem

The README skill tables are hand-maintained and can drift from the actual skill frontmatter. Adding or renaming a skill requires updating both the SKILL.md and the README, and it's easy to forget or get descriptions out of sync.

Solution

Add scripts/build-readme.mjs — a zero-dependency Node script that generates the "Available Skills" section of README.md from skill frontmatter. Uses <!-- GENERATED:SKILLS:START --> / <!-- GENERATED:SKILLS:END --> markers so hand-written content outside the section is preserved. Supports --check mode for CI.

Skill descriptions now come directly from frontmatter, so updating a skill's description in one place updates the README too.

Borrowed from vercel/vercel-plugin which generates its skill inventory tables from metadata rather than maintaining them by hand.

How to test

  1. Run node scripts/build-readme.mjs — regenerates the skills section
  2. Run node scripts/build-readme.mjs --check — exits 0 if up to date
  3. Try changing a skill's description in its frontmatter, then run --check to see it flag the drift

Made with Cursor

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant