Add doc validation skills for ui-extensions#4085
Merged
rennyG merged 2 commits into2026-04-rcfrom Mar 20, 2026
Merged
Conversation
rennyG
commented
Mar 11, 2026
Contributor
Author
There was a problem hiding this comment.
For all of skills where it's relevant to do so, we should validate against the live schema. We should also ensure the LLM is indicating what it can't verify, what should change, and if it doesn't know what should change, it recommends we remove the claim
9711d2d to
2c1bb75
Compare
f2d42e1 to
4972048
Compare
This was referenced Mar 20, 2026
110ff99 to
77524f9
Compare
…ions-skills-2026-04-rc
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.
Closes https://github.com/shop/issues-learn/issues/1073
Supercedes #4084
Adds Claude Code skills for validating documentation updates in this repo. Used by the docs team.
Skills added
ui-extensions:router— entry point, routes to correct skills by page typeui-extensions:style-lint— mechanical text checks (contractions, punctuation, formatting, capitalization, file references)ui-extensions:examples— example quality checks covering only what the automated script can't (uniqueness, description pattern, usefulness) + live schema validation via MCPui-extensions:components— component description format, best practices, limitations + live schema validation via MCPui-extensions:apis— API descriptions, JSDoc authoring quality, supported tags, shared component docsui-extensions:type-definitions— JSDoc quality, slots, events, architecture patternsui-extensions:cross-surface— consistency across checkout and customer accountui-extensions:link-validation— link verification via MCP tools (run separately)ui-extensions:build-verification— docs generation and JSON verificationDesign
.d.tstype definitions — if a description mentions a prop, method, or behavior that doesn't exist in the type, it's flagged as a must-fix. Claims that can't be verified are flagged explicitly, with a recommendation to confirm or remove.validate_component_codeblocksMCP tool to verify HTML examples against the published Shopify component schemaTesting — how to review these skills
You'll need Claude Code with this branch checked out. The skills live in
.claude/skills/and are available automatically once you open a terminal in this repo.To try a skill, open a Claude Code session in this repo and ask it to validate a file. Name the skill explicitly in your prompt:
Not sure where to start? Pick any component or API
.doc.tsfile that's been updated recently and runui-extensions:style-linton it. The output format is a short Validation Report — it should feel useful and specific, not a wall of checkboxes.Link validation (uses MCP tools, slower): invoke
ui-extensions:link-validationseparately and pass it a file with documentation links.What to check as a reviewer:
Not in scope — follow-up skills for shopify-dev repo
The following skills were intentionally left out because the content they validate lives in
shopify-dev, not this repo. They'll be added in a separate PR against that repo:.mdxcomponent prop validation — validates props on components like<Chip>,<ExtensionSupports>,<ExampleSwitcher>,<AccordionLabel>,<ExpandableImage>used in shopify-dev.mdxpages{API_VERSION}placeholders, no duplicate accordion IDs<ExtensionSupports>,<ExampleSwitcher>, example quality, best practices/limitations.mdxpages match the official target API