From 53985598ddb7a9d5568a23c154a0183395c14a8f Mon Sep 17 00:00:00 2001 From: Steven Spriggs Date: Wed, 13 May 2026 12:45:17 -0400 Subject: [PATCH] chore: improve phase 5 cem alignment documentation comments --- .claude/skills/review-api/SKILL.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/.claude/skills/review-api/SKILL.md b/.claude/skills/review-api/SKILL.md index e8df36b27c..20479c0f98 100644 --- a/.claude/skills/review-api/SKILL.md +++ b/.claude/skills/review-api/SKILL.md @@ -124,13 +124,16 @@ npx stylelint elements/pf-v6-{name}/**/*.css - [ ] No arrow functions in test blocks? - [ ] Behavioral expectations from React tests covered? -### Phase 5: JSDoc +### Phase 5: JSDoc and cem documentation comments - [ ] `@summary` present on element class? - [ ] All public properties/methods have `/** */` JSDoc (not `//` comments)? -- [ ] `@cssprop` with CSS data types: `@cssprop {color} --pf-v6-c-button--Color`? -- [ ] `@csspart` for all exposed parts? -- [ ] `@slot` for all slots (prescriptive descriptions)? +- [ ] CSS custom properties documented with `/** */` comments in the CSS file, +co-located with the declaration or `var()` reference? +- [ ] CSS parts documented with `` HTML comments before the +`part="..."` element in the template? +- [ ] Slots documented with `` HTML comments before the `` +element in the template? - [ ] `@fires` for all dispatched events? - [ ] No unnecessary `@default` tags (analyzer picks up initializers)?