web-design-guidelines

Review UI code against Web Interface Guidelines and report findings in file:line format.

Updated Apr 22, 2024
One-click install
npx skills add https://github.com/oligamiq/fast-explorer --skill web-design-guidelines-oligamiq
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: web-design-guidelines
Source: https://github.com/oligamiq/fast-explorer/tree/main/.agents/skills/web-design-guidelines
Command: npx skills add https://github.com/oligamiq/fast-explorer --skill web-design-guidelines-oligamiq

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Manually auditing UI code for accessibility and design best practices is slow 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 stay current. - File or Pattern Targeting: Accepts a specific file or glob pattern as an argument, or prompts you for files to review. - Terse Output Format: Reports findings in a compact file:line format for quick triage. - Use Case: Before shipping a new landing page, ask for a review of your React components to catch accessibility violations and design guideline breaches. ## Quick Start Ask the assistant to review my UI files in src/components against the web interface guidelines.

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 or glob pattern as an argument, and the Skill fetches the latest Web Interface Guidelines, reads your files, and checks them against every rule. Findings are reported in a terse file:line format for quick fixes.

What guidelines does this UI review check against?▼

It checks against the Web Interface Guidelines maintained in the vercel-labs web-interface-guidelines repository. The rules are fetched fresh from the source URL before each review, so audits always use the latest version.

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.

Does the UI review work offline?▼

No, the review requires network access because it fetches the latest guidelines from a remote URL before each run. Without connectivity, the current rules cannot be retrieved and the review cannot proceed.

What output format does the design audit produce?▼

Findings are output in a terse file:line format as specified by the fetched guidelines. This makes it easy to jump directly to each violation in your editor.