Skip to content

docs: give the root README a full overview and gate the directory scan checks - #109

Open
chris-addison wants to merge 2 commits into
mainfrom
docs/directory-scan-checks
Open

chris-addison wants to merge 2 commits into
mainfrom
docs/directory-scan-checks

Conversation

@chris-addison

Copy link
Copy Markdown
Contributor

The Claude Code plugin directory scan checks that the root README.md has at least 40 words and that no skill description contains angle brackets (like <genre>). A failed scan holds the listing update back, and we only find out after submitting.

Changes

  • Root README.md: expanded from an 18-word stub to a ~90-word overview of what the skills cover, with a link to the full README. It has no install steps, so Antigravity's marketplace overview (which renders the root README) stays short. The full README stays in .github/README.md.
  • scripts/check-skill-frontmatter.mjs: also fails on angle brackets in a skill description (checked on the parsed YAML, so description: >- is fine) and on a root README that is missing or under 40 words.
  • validate-skills.yml: runs when README.md changes.

How to test

node scripts/check-skill-frontmatter.mjs skills passes on this branch (32 skills). With the old stub README and <genre> added to the ui description, it reports both problems and exits 1.

🤖 Generated with Claude Code

chris-addison and others added 2 commits October 29, 2026 11:46
…n checks

The Claude Code plugin directory scan wants a root README.md of at least 40
words and no angle brackets in skill descriptions. The root README was an
18-word stub, kept short on purpose because Antigravity shows it as the
marketplace overview. It now describes what the skills cover in about 90
words and links to the full README in .github/, which still holds the
install steps.

check-skill-frontmatter.mjs now fails on angle brackets in a description and
on a root README under 40 words, and the skills workflow runs when README.md
changes.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@chris-addison
chris-addison marked this pull request as ready for review October 29, 2026 20:13
@chris-addison
chris-addison requested a review from a team as a code owner October 29, 2026 20:13
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