Update Plugin README
Regenerates the "Skills" section of a Claude Code skills plugin README from the actual contents of its skills/ directory.
When to run
- A new skill has been added to the plugin's
skills/ folder.
- A skill's frontmatter
description has been edited.
- A skill has been removed.
- The README drifts from reality (e.g. lists planned skills that already ship).
Procedure
- Run
python3 scripts/generate-skills-section.py <plugin-repo-path> (default: the current plugin repo).
- The script emits a block starting with
<!-- SKILLS:START --> and ending with <!-- SKILLS:END -->. Capture its stdout.
- Open
README.md. Replace everything between those two markers with the new block. If the markers don't exist, locate the existing ## Skills heading and replace that section (up to the next ## heading) with the new block wrapped in markers; if there's no ## Skills heading, insert the block after the README's opening paragraph.
- Remove any "Planned scope" section that contains items now implemented. Leave genuinely unimplemented items alone but move them into an "Ideas" section if still plausible; drop them otherwise.
- Show the user a diff before committing.
Category taxonomy
The helper script uses folder-name inference. Preferred explicit category values (add to a skill's SKILL.md frontmatter if inference gets it wrong):
| Category |
Scope |
Government & Civic |
Postal service, municipal reports, vehicle licensing, national services |
Healthcare |
HMOs, medicines, medical appointments |
Emergency Preparedness |
Shelters, Home Front Command guidelines, alerts |
Localization |
Hebrew language, fonts, translation |
Media & Information |
News feeds, media lookups |
Meta / Tooling |
Skills that manage the plugin itself |
Category ordering in the README is fixed (Government & Civic → Healthcare → Emergency Preparedness → Localization → Media & Information → Meta / Tooling → Other).
Fallback category inference rules
If a SKILL.md lacks a category field, the script infers from folder name:
*-municipality-*, israel-post-*, *-government-* → Government & Civicmaccabi-*, clalit-*, meuhedet-*, leumit-*, *-medicine-*, *-medical-* → Healthcare*-shelter-*, miklat*, home-front-*, pikud-*, *-alert-* → Emergency Preparednesshebrew-*, *-translation, *-fonts-* → Localization*-news-*, *-rss-* → Media & Informationadd-skill-*, update-plugin-*, install-*-plugin, *-plugin-* → Meta / Tooling- Otherwise → Other (prompt the user)
Prefer adding the category field to the skill's frontmatter over relying on inference.
Description sanitisation
The full description frontmatter for a skill is discovery-oriented (contains "Use when..." preamble and trigger phrases). The README version is a plain, user-facing sentence. The helper script strips the Use when the user wants to prefix, truncates at the first sentence boundary, cuts everything from Trigger phrases onward, capitalises the first letter, and drops the trailing period.
Out of scope
- Regenerating the rest of the README (header, installation, license, related plugins). Those are hand-maintained.
- Editing individual SKILL.md files. This skill only reads them.
1---2name: update-plugin-readme3description: Use when the user wants to refresh the README of this plugin (or any Claude Code skills plugin) so that its "Skills" section reflects the current set of skills under `skills/*/SKILL.md`. Reads each skill's frontmatter (`name`, `description`, optional `category`), groups by category, sorts alphabetically within each group, and rewrites the README's Skills section between the `<!-- SKILLS:START -->` and `<!-- SKILLS:END -->` markers. Preserves everything else in the README (header, installation, license). A helper script at `scripts/generate-skills-section.py` does the extraction and emits the block on stdout; the skill is responsible for splicing it into the README. Trigger phrases - "update the plugin README", "regenerate the skills table", "refresh skills list on the plugin README", "the plugin README is out of date", "add the new skill to the README".4---56# Update Plugin README78Regenerates the "Skills" section of a Claude Code skills plugin README from the actual contents of its `skills/` directory.910## When to run1112- A new skill has been added to the plugin's `skills/` folder.13- A skill's frontmatter `description` has been edited.14- A skill has been removed.15- The README drifts from reality (e.g. lists planned skills that already ship).1617## Procedure18191. Run `python3 scripts/generate-skills-section.py <plugin-repo-path>` (default: the current plugin repo).202. The script emits a block starting with `<!-- SKILLS:START -->` and ending with `<!-- SKILLS:END -->`. Capture its stdout.213. Open `README.md`. Replace everything between those two markers with the new block. If the markers don't exist, locate the existing `## Skills` heading and replace that section (up to the next `##` heading) with the new block wrapped in markers; if there's no `## Skills` heading, insert the block after the README's opening paragraph.224. Remove any "Planned scope" section that contains items now implemented. Leave genuinely unimplemented items alone but move them into an "Ideas" section if still plausible; drop them otherwise.235. Show the user a diff before committing.2425## Category taxonomy2627The helper script uses folder-name inference. Preferred explicit `category` values (add to a skill's SKILL.md frontmatter if inference gets it wrong):2829| Category | Scope |30|---|---|31| `Government & Civic` | Postal service, municipal reports, vehicle licensing, national services |32| `Healthcare` | HMOs, medicines, medical appointments |33| `Emergency Preparedness` | Shelters, Home Front Command guidelines, alerts |34| `Localization` | Hebrew language, fonts, translation |35| `Media & Information` | News feeds, media lookups |36| `Meta / Tooling` | Skills that manage the plugin itself |3738Category ordering in the README is fixed (Government & Civic → Healthcare → Emergency Preparedness → Localization → Media & Information → Meta / Tooling → Other).3940## Fallback category inference rules4142If a SKILL.md lacks a `category` field, the script infers from folder name:4344- `*-municipality-*`, `israel-post-*`, `*-government-*` → Government & Civic45- `maccabi-*`, `clalit-*`, `meuhedet-*`, `leumit-*`, `*-medicine-*`, `*-medical-*` → Healthcare46- `*-shelter-*`, `miklat*`, `home-front-*`, `pikud-*`, `*-alert-*` → Emergency Preparedness47- `hebrew-*`, `*-translation`, `*-fonts-*` → Localization48- `*-news-*`, `*-rss-*` → Media & Information49- `add-skill-*`, `update-plugin-*`, `install-*-plugin`, `*-plugin-*` → Meta / Tooling50- Otherwise → Other (prompt the user)5152Prefer adding the `category` field to the skill's frontmatter over relying on inference.5354## Description sanitisation5556The full `description` frontmatter for a skill is discovery-oriented (contains "Use when..." preamble and trigger phrases). The README version is a plain, user-facing sentence. The helper script strips the `Use when the user wants to ` prefix, truncates at the first sentence boundary, cuts everything from `Trigger phrases` onward, capitalises the first letter, and drops the trailing period.5758## Out of scope5960- Regenerating the rest of the README (header, installation, license, related plugins). Those are hand-maintained.61- Editing individual SKILL.md files. This skill only reads them.
danielrosehill