chore: add review docs skill - #3162
Conversation
|
✅ Commitlint tests passed!More Info{
"valid": true,
"errors": [],
"warnings": [],
"input": "chore: add review docs skill"
} |
✅ Deploy Preview for patternfly-elements ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
| ## Principles | ||
|
|
||
| - Co-location: document each API surface next to the code it describes | ||
| - Inline CSS comments are the primary documentation for custom properties | ||
| - HTML template comments are the sole documentation for slots and parts | ||
| - Do NOT use `@slot` or `@csspart` JSDoc tags — remove them if found | ||
| - `@fires` and `@attr` JSDoc remain the preferred method for events and attributes | ||
| - Documentation feeds LSP, MCP, and dev server — quality directly affects DX |
There was a problem hiding this comment.
I wonder if this section is necessary seems repetitive and unnecessary context filler. Likely can remove
zeroedin
left a comment
zeroedin
left a comment
There was a problem hiding this comment.
LGTM with one minor suggestion
2 participants
What I did
review-docsSKILL to clean up tendencies to use JSDocs-style @cssprop and @slot for documentation instead of the preferred inline comments.