web-design-guidelines ยท diff
v1.0.0 to v1.0.0
31 added, 8 removed. Audit A to A.
---
name: web-design-guidelines
description: Review UI code for Web Interface Guidelines compliance. Use when asked to "review my UI", "check accessibility", "audit design", "review UX", or "check my site against best practices".
metadata:
author: vercel
version: "1.0.0"
argument-hint: <file-or-pattern>
---
# Web Interface Guidelines
Review files for compliance with Web Interface Guidelines.
## How It Works
- 1. Fetch the latest guidelines from the source URL below
+ 1. Read the guidelines from `#[[file:references/guideline.md]]`
2. Read the specified files (or prompt user for files/pattern)
- 3. Check against all rules in the fetched guidelines
+ 3. Check against all rules in the guidelines
4. Output findings in the terse `file:line` format
- ## Guidelines Source
+ ## Guidelines Reference
- Fetch fresh guidelines before each review:
+ All rules and output format instructions are in:
```
- https://raw.githubusercontent.com/vercel-labs/web-interface-guidelines/main/command.md
+ #[[file:references/guideline.md]]
```
- Use WebFetch to retrieve the latest rules. The fetched content contains all the rules and output format instructions.
+ The guidelines cover:
+ - Accessibility (ARIA, semantic HTML, keyboard navigation)
+ - Focus states and keyboard interaction
+ - Forms (autocomplete, validation, labels)
+ - Animation (reduced motion, performance)
+ - Typography (proper characters, number formatting)
+ - Content handling (overflow, empty states)
+ - Images (dimensions, lazy loading)
+ - Performance (virtualization, DOM reads)
+ - Navigation & state (URL sync, deep linking)
+ - Touch & interaction (tap delays, safe areas)
+ - Dark mode & theming
+ - Locale & i18n
+ - Hydration safety
+ - Common anti-patterns to flag
## Usage
When a user provides a file or pattern argument:
- 1. Fetch guidelines from the source URL above
+ 1. Read the guidelines from `references/guideline.md`
2. Read the specified files
- 3. Apply all rules from the fetched guidelines
+ 3. Apply all rules from the guidelines
4. Output findings using the format specified in the guidelines
If no files specified, ask the user which files to review.
+
+ ## Output Format
+
+ Follow the format in the guidelines:
+ - Group findings by file
+ - Use `file:line` format (VS Code clickable)
+ - Terse, high signal-to-noise
+ - State issue + location
+ - Skip explanation unless fix is non-obvious