Web Interface Guidelines
Review files for compliance with Web Interface Guidelines.
How It Works
- Fetch the latest guidelines from the source URL below
- Read the specified files (or prompt user for files/pattern)
- Check against all rules in the fetched guidelines
- Output findings in the terse
file:lineformat
Guidelines Source
Fetch fresh guidelines before each review:
https://raw.githubusercontent.com/vercel-labs/web-interface-guidelines/main/command.md
Use WebFetch to retrieve the latest rules. The fetched content contains all the rules and output format instructions.
Usage
When a user provides a file or pattern argument:
- Fetch guidelines from the source URL above
- Read the specified files
- Apply all rules from the fetched guidelines
- Output findings using the format specified in the guidelines
If no files specified, ask the user which files to review.
Outputs & Deliverables
- Primary Output: Accessibility and design review findings in
file:lineformat and a short remediation list - Secondary Output: Suggested code snippets or CSS fixes for small violations
- Success Criteria: No critical accessibility failures and clear remediation steps for others
- Quality Gate:
implementerreview for fixes prior to merge
Constraints
- Technical Constraints: Do not modify source files automatically; produce recommended fixes only
- Scope Constraints: Focus on UI guidelines and accessibility; visual design approvals are separate
- Governance Constraints: Use latest guidelines from the canonical source before each review
Common Pitfalls
- Stale Guidelines: Using local cached guidelines instead of fetching fresh ones. Always fetch from the canonical source before each review.
- Skipping Accessibility: Checking only visual design, not keyboard navigation or screen reader support. Accessibility is mandatory, not optional.
- Ignoring Contrast Ratios: Visual text looks fine but fails WCAG contrast requirements. Always validate color contrasts programmatically.
- Missing Responsive Testing: UI looks good on desktop but breaks on mobile. Test at multiple breakpoints.
- Not Suggesting Fixes: Reporting problems without showing how to fix them. Always provide remediation code snippets.
- Vague Findings: "Design looks off" instead of specific violations. Reference exact lines and rules.
Integration Points
| Phase | Input From | Output To | Context |
|---|---|---|---|
| Review Request | UI code files | Guidelines fetch | Retrieve canonical guidelines from source |
| Analysis | Code patterns and styles | Findings report | Identify violations against guidelines |
| Remediation | Violations found | implementer |
Provide code examples for fixes |
| Merge Gate | UI changes complete | QA approval | No critical accessibility issues before merge |