diff --git a/docs/skill-optimizer/web-design-guidelines/01-functionality.md b/docs/skill-optimizer/web-design-guidelines/01-functionality.md new file mode 100644 index 0000000..b04758a --- /dev/null +++ b/docs/skill-optimizer/web-design-guidelines/01-functionality.md @@ -0,0 +1,225 @@ +--- +skill_source: https://github.com/vercel-labs/agent-skills/blob/main/skills/web-design-guidelines/SKILL.md +pr_submission_intent: true +classification: ui-code-review-checklist +optimization_target: command.md +optimization_target_source: https://raw.githubusercontent.com/vercel-labs/web-interface-guidelines/main/command.md +optimization_target_candidates: + - path: SKILL.md + source: https://raw.githubusercontent.com/vercel-labs/agent-skills/main/skills/web-design-guidelines/SKILL.md + rationale: 39-line wrapper that only orchestrates a WebFetch; no substantive rules to test or improve. + - path: command.md + source: https://raw.githubusercontent.com/vercel-labs/web-interface-guidelines/main/command.md + rationale: The actual rule corpus (~80 checklist items across 15 categories) that every review applies; this is where behavior lives. +likely_wrapper: true +wrapper_points_to: https://raw.githubusercontent.com/vercel-labs/web-interface-guidelines/main/command.md +--- + +# web-design-guidelines — functionality briefing + +## 1. What the skill does + +`web-design-guidelines` is a UI code review checklist skill. When an agent is asked to review front-end source files (JSX/TSX/HTML/CSS), the skill fetches a curated set of Vercel "Web Interface Guidelines" rules and applies them to the provided files, emitting a terse `file:line - issue` report grouped by file. It is fundamentally a static review pass — read the files, match each rule against the source, and report violations in a compact format optimized for IDE clickthrough. The substantive content (the rules themselves and the output format) is not embedded in the published SKILL.md; the SKILL.md is a thin wrapper that WebFetches `command.md` from a separate `vercel-labs/web-interface-guidelines` repo on every invocation. + +## 2. Who uses it + +End-user agents (Claude Code, Cursor, Codex, etc.) running on a developer's machine while that developer is iterating on a web UI. The consumer is the agent; the human audience is a front-end engineer who wants a fast lint-like sanity pass over component code before opening a PR or shipping. + +## 3. When it should fire + +Per the wrapper SKILL.md description, the skill should trigger on user phrasing like: + +- "review my UI" +- "check accessibility" +- "audit design" +- "review UX" +- "check my site against best practices" + +Implicit triggers: any request to review/audit/inspect front-end files (`.tsx`, `.jsx`, `.html`, `.css`, component code) against design-system / accessibility / performance heuristics. + +## 4. Responsibilities + +Every rule in `command.md` is a candidate testable behavior. They group naturally into the categories `command.md` itself uses: + +### Accessibility (10 rules) + +- Icon-only buttons need `aria-label` +- Form controls need `