Skip to content

Add doc validation skills for ui-extensions#4084

Closed
rennyG wants to merge 3 commits into2026-04-rcfrom
add-doc-validation-skills
Closed

Add doc validation skills for ui-extensions#4084
rennyG wants to merge 3 commits into2026-04-rcfrom
add-doc-validation-skills

Conversation

@rennyG
Copy link
Copy Markdown
Contributor

@rennyG rennyG commented Mar 11, 2026

Closed in favour of #4085

Adds Claude Code skills for validating documentation updates in this repo. Used by the docs team.

Closes https://github.com/Shopify/temp-project-mover-Archetypically-20260313091522/issues/343

Skills added

  • ui-extensions:router — entry point, routes to correct skills by page type
  • ui-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)
  • ui-extensions:components — component description format, best practices, limitations
  • ui-extensions:apis — API .doc.ts structure, properties, methods, helper docs
  • ui-extensions:type-definitions — JSDoc quality, slots, events, source of truth
  • ui-extensions:cross-surface — consistency across admin, checkout, POS
  • ui-extensions:link-validation — link verification via MCP tools (run separately)
  • ui-extensions:build-verification — docs generation and JSON verification

Design

  • All skills invoked manually, not auto-triggered
  • Output format: Validation Report (what's good / needs attention / must fix / recommendation)
  • Style-lint and examples are split so Claude doesn't context-switch between mechanical scanning and subjective judgment
  • Example validation explicitly defers to the existing automated script for syntax/rendering checks

@rennyG rennyG self-assigned this Mar 11, 2026
@rennyG rennyG added the #gsd:49303 Shopify Dev Docs: UI Extension Reference Docs: Quality & Completeness label Mar 11, 2026
@rennyG rennyG force-pushed the add-doc-validation-skills branch from 8b1f8fe to c9a9276 Compare March 11, 2026 17:36
@rennyG rennyG closed this Mar 11, 2026
@rennyG rennyG deleted the add-doc-validation-skills branch March 11, 2026 17:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

#gsd:49303 Shopify Dev Docs: UI Extension Reference Docs: Quality & Completeness

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant