web-design-guidelines

Reviews UI code files against Vercel Web Interface Guidelines and reports findings.

7|1|Updated Mar 29, 2024
One-click install
npx skills add https://github.com/aBgAmeuR/harmony --skill web-design-guidelines-abgameur
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: web-design-guidelines
Source: https://github.com/aBgAmeuR/harmony/tree/main/.agents/skills/web-design-guidelines
Command: npx skills add https://github.com/aBgAmeuR/harmony --skill web-design-guidelines-abgameur

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Manually auditing UI code for accessibility, UX, and design best practices is time-consuming and inconsistent. This Skill automates the review by fetching the latest Web Interface Guidelines and checking your files against every rule. ## Core Features & Use Cases - Guideline-Based Review: Fetches the latest rules from the vercel-labs web-interface-guidelines repository before each audit, so checks always reflect current best practices. - File or Pattern Targeting: Accepts a specific file or glob pattern as an argument, or prompts you to specify which files to review. - Terse Findings Output: Reports violations in a compact file:line format for quick triage and fixing. - Use Case: Before shipping a new landing page, ask for a review of your React components to catch accessibility issues, inconsistent patterns, and UX anti-patterns. ## Quick Start Review my UI code in src/components against the web interface guidelines and list all violations.

Frequently Asked Questions about web-design-guidelines

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I review my UI code for accessibility issues?

Provide a file path or glob pattern for your UI files, and the Skill fetches the latest Web Interface Guidelines and checks your code against every rule. Findings are reported in a compact file:line format so you can fix issues quickly.

What guidelines does this UI review use?

It fetches the Web Interface Guidelines maintained by vercel-labs from their GitHub repository before each review. This ensures the audit always uses the most current rules rather than a stale local copy.

Can I review multiple files or a whole directory at once?

Yes, you can pass a file pattern as the argument to review multiple matching files in one run. If you provide no argument, the Skill asks which files you want reviewed.

What output format does the UI audit produce?

Findings are output in a terse file:line format as specified by the fetched guidelines. Each violation points directly to the location in your code that needs attention.

Does the UI review work offline?

No, the Skill requires network access to fetch the latest guidelines from the vercel-labs GitHub repository via WebFetch before each review. Without connectivity, the rules cannot be retrieved.