Generate README skill inventory from frontmatter#8
Open
robinandeer wants to merge 1 commit intomainfrom
Open
Conversation
Made-with: Cursor
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.mdand 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 ofREADME.mdfrom skill frontmatter. Uses<!-- GENERATED:SKILLS:START -->/<!-- GENERATED:SKILLS:END -->markers so hand-written content outside the section is preserved. Supports--checkmode 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
node scripts/build-readme.mjs— regenerates the skills sectionnode scripts/build-readme.mjs --check— exits 0 if up to datedescriptionin its frontmatter, then run--checkto see it flag the driftMade with Cursor