agents-templated 1.2.3 → 1.2.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -122,7 +122,6 @@ your-project/
122
122
  ├── agent-docs/ # 📚 Comprehensive documentation
123
123
  │ ├── AGENTS.md # AI assistant guide
124
124
  │ ├── ARCHITECTURE.md # Project architecture & tech stack
125
- │ ├── AGENTS.MD # Agent delegation patterns
126
125
  │ └── README.md # Human-readable setup guide
127
126
 
128
127
  ├── agents/ # 🤖 AI Agent rules and skills
@@ -134,8 +133,9 @@ your-project/
134
133
  │ │ ├── database.mdc # Database patterns
135
134
  │ │ └── style.mdc # Code style guidelines
136
135
  │ └── skills/
137
- │ ├── web-design-guidelines/ # UI/UX patterns
138
- └── find-skills/ # Skill discovery
136
+ │ ├── find-skills/ # Skill discovery helper
137
+ ├── README.md # Guide for creating custom skills
138
+ │ └── [your-custom-skills]/ # Your project-specific skills
139
139
 
140
140
  ├── .github/
141
141
  │ └── copilot-instructions.md # GitHub Copilot config
@@ -224,15 +224,49 @@ Open your AI assistant and it will automatically load the appropriate config:
224
224
  - **Claude**: Reads `CLAUDE.md`
225
225
  - **Gemini**: Reads `GEMINI.md`
226
226
 
227
- ### 3. Read the Documentation
227
+ ### 3. Create Custom Skills (Optional)
228
+
229
+ Extend your AI agents with domain-specific skills for your project:
230
+
231
+ ```bash
232
+ # View the skills guide
233
+ cat agents/skills/README.md
234
+ ```
235
+
236
+ Create a new skill folder in `agents/skills/`:
237
+
238
+ ```markdown
239
+ agents/skills/my-custom-skill/SKILL.md
240
+ ---
241
+ name: my-custom-skill
242
+ description: Custom patterns for my project domain
243
+ ---
244
+
245
+ # My Custom Skill
246
+
247
+ Use this skill when working with [your domain].
248
+
249
+ ## Recommended Patterns
250
+
251
+ - Pattern 1: Description
252
+ - Pattern 2: Description
253
+
254
+ ## Example
255
+
256
+ Code and examples...
257
+ ```
258
+
259
+ Skills define *how to execute specific tasks*, complementing rules that define *how to behave*. See [agents/skills/README.md](agents/skills/README.md) for detailed guidance.
260
+
261
+ ### 4. Read the Documentation
228
262
 
229
263
  - **[AGENTS.md](AGENTS.md)** – AI assistant guide
230
264
  - **[agent-docs/ARCHITECTURE.md](agent-docs/ARCHITECTURE.md)** – Project architecture & tech stack guidance
231
- - **[AGENTS.md](AGENTS.md)** – AI assistant guide
265
+ - **[agents/skills/README.md](agents/skills/README.md)** – Custom skills guide
232
266
  - **[agents/rules/security.mdc](agents/rules/security.mdc)** – Security patterns (CRITICAL)
233
267
  - **[agents/rules/testing.mdc](agents/rules/testing.mdc)** – Testing strategy
234
268
 
235
- ### 4. Start Building
269
+ ### 5. Start Building
236
270
 
237
271
  Tell your AI assistant what to build:
238
272
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "agents-templated",
3
- "version": "1.2.3",
3
+ "version": "1.2.6",
4
4
  "description": "Technology-agnostic development template with multi-AI agent support (Cursor, Copilot, VSCode, Gemini), security-first patterns, and comprehensive testing guidelines",
5
5
  "main": "index.js",
6
6
  "bin": {
@@ -4,9 +4,9 @@ This project follows enterprise-grade, technology-agnostic development patterns.
4
4
 
5
5
  ## Quick Start
6
6
 
7
- - **AI Guide**: See `agent-docs/AI_INSTRUCTIONS.md` for comprehensive instructions
7
+ - **AI Guide**: See `AGENTS.md` for comprehensive instructions
8
8
  - **Architecture**: See `agent-docs/ARCHITECTURE.md` for project guidelines
9
- - **Agent Patterns**: See `agent-docs/AGENTS.md` for delegation patterns
9
+ - **Custom Skills**: See `agents/skills/` directory for domain-specific extensions
10
10
  - **Detailed Rules**: See `agents/rules/*.mdc` files
11
11
 
12
12
  ## Always Apply
@@ -6,6 +6,7 @@ This project follows enterprise-grade, technology-agnostic development patterns.
6
6
 
7
7
  - **`AGENTS.md`** - This file! AI instructions for working with AI assistants
8
8
  - **`agent-docs/ARCHITECTURE.md`** - Overall project guidelines, architecture principles, and technology stack selection
9
+ - **`agents/skills/`** - Custom skills for domain-specific tasks in your project
9
10
 
10
11
  ## Detailed Rules (Reference When Relevant)
11
12
 
@@ -23,10 +24,11 @@ When implementing features, always check the relevant rule file:
23
24
 
24
25
  When implementing any feature:
25
26
 
26
- 1. **Reference `agent-docs/ARCHITECTURE.md`** for overall architecture and technology stack guidance
27
- 2. **Apply relevant rules** from `agents/rules/*.mdc` files based on the task
28
- 3. **Always apply security patterns** from `agents/rules/security.mdc`
29
- 4. **Always apply testing patterns** from `agents/rules/testing.mdc`
27
+ 1. **Check for custom skills**: Review `agents/skills/` for domain-specific guidance
28
+ 2. **Reference `agent-docs/ARCHITECTURE.md`** for overall architecture and technology stack guidance
29
+ 3. **Apply relevant rules** from `agents/rules/*.mdc` files based on the task
30
+ 4. **Always apply security patterns** from `agents/rules/security.mdc`
31
+ 5. **Always apply testing patterns** from `agents/rules/testing.mdc`
30
32
 
31
33
  ## Critical Rules (Always Apply)
32
34
 
@@ -6,7 +6,7 @@ This project uses enterprise-grade, technology-agnostic development patterns for
6
6
 
7
7
  - **AI Guide**: See `AGENTS.md` for comprehensive instructions
8
8
  - **Architecture**: See `agent-docs/ARCHITECTURE.md` for project guidelines
9
- - **AI Guide**: See `AGENTS.md` for AI assistant patterns
9
+ - **Custom Skills**: See `agents/skills/` directory for domain-specific extensions
10
10
  - **Detailed Rules**: See `agents/rules/*.mdc` files
11
11
 
12
12
  ## Always Apply
@@ -10,9 +10,9 @@ This project uses enterprise-grade, technology-agnostic development patterns for
10
10
 
11
11
  - **AI Guide**: See `AGENTS.md` for comprehensive instructions
12
12
  - **Architecture**: See `agent-docs/ARCHITECTURE.md` for project guidelines
13
- - **AI Guide**: See `AGENTS.md` for AI assistant patterns
13
+ - **Custom Skills**: See `agents/skills/` directory for domain-specific extensions
14
14
  - **Detailed Rules**: See `agents/rules/*.mdc` files
15
- - **Available Skills**: See `agents/skills/` directory
15
+ - **Available Skills**: Check `agents/skills/` for project-specific skills
16
16
 
17
17
  ## Core Development Patterns
18
18
 
@@ -118,7 +118,6 @@ your-project/
118
118
  ├── agent-docs/ # 📚 Comprehensive documentation
119
119
  │ ├── AGENTS.md # AI assistant guide
120
120
  │ ├── ARCHITECTURE.md # Project architecture & tech stack
121
- │ ├── AGENTS.MD # Agent delegation patterns
122
121
  │ └── README.md # Human-readable setup guide
123
122
 
124
123
  ├── agents/ # 🤖 AI Agent rules and skills
@@ -130,8 +129,9 @@ your-project/
130
129
  │ │ ├── database.mdc # Database patterns
131
130
  │ │ └── style.mdc # Code style guidelines
132
131
  │ └── skills/
133
- │ ├── web-design-guidelines/ # UI/UX patterns
134
- └── find-skills/ # Skill discovery
132
+ │ ├── find-skills/ # Skill discovery helper
133
+ ├── README.md # Guide for creating custom skills
134
+ │ └── [your-custom-skills]/ # Your project-specific skills
135
135
 
136
136
  ├── .github/
137
137
  │ └── copilot-instructions.md # GitHub Copilot config
@@ -220,15 +220,49 @@ Open your AI assistant and it will automatically load the appropriate config:
220
220
  - **Claude**: Reads `CLAUDE.md`
221
221
  - **Gemini**: Reads `GEMINI.md`
222
222
 
223
- ### 3. Read the Documentation
223
+ ### 3. Create Custom Skills (Optional)
224
+
225
+ Extend your AI agents with domain-specific skills for your project:
226
+
227
+ ```bash
228
+ # View the skills guide
229
+ cat agents/skills/README.md
230
+ ```
231
+
232
+ Create a new skill folder in `agents/skills/`:
233
+
234
+ ```markdown
235
+ agents/skills/my-custom-skill/SKILL.md
236
+ ---
237
+ name: my-custom-skill
238
+ description: Custom patterns for my project domain
239
+ ---
240
+
241
+ # My Custom Skill
242
+
243
+ Use this skill when working with [your domain].
244
+
245
+ ## Recommended Patterns
246
+
247
+ - Pattern 1: Description
248
+ - Pattern 2: Description
249
+
250
+ ## Example
251
+
252
+ Code and examples...
253
+ ```
254
+
255
+ Skills define *how to execute specific tasks*, complementing rules that define *how to behave*. See [agents/skills/README.md](agents/skills/README.md) for detailed guidance.
256
+
257
+ ### 4. Read the Documentation
224
258
 
225
259
  - **[AGENTS.md](AGENTS.md)** – AI assistant guide
226
260
  - **[agent-docs/ARCHITECTURE.md](agent-docs/ARCHITECTURE.md)** – Project architecture & tech stack guidance
227
- - **[AGENTS.md](AGENTS.md)** – Working with AI assistants guide
261
+ - **[agents/skills/README.md](agents/skills/README.md)** – Custom skills guide
228
262
  - **[agents/rules/security.mdc](agents/rules/security.mdc)** – Security patterns (CRITICAL)
229
263
  - **[agents/rules/testing.mdc](agents/rules/testing.mdc)** – Testing strategy
230
264
 
231
- ### 4. Start Building
265
+ ### 5. Start Building
232
266
 
233
267
  Tell your AI assistant what to build:
234
268
 
@@ -36,16 +36,43 @@ agents-templated list
36
36
 
37
37
  ## Rules and Skills
38
38
 
39
- - **Rules** (`agents/rules/*.mdc`): Markdown files with YAML frontmatter (`description`, `globs`, `alwaysApply`). AI agents use them to know when to apply each rule. Adapt the content to your stack.
40
- - **Skills** (`agents/skills/*/SKILL.md`): Extend agent capabilities (e.g. find-skills, web-design-guidelines). Each has a name, description, and when to use.
39
+ - **Rules** (`agents/rules/*.mdc`): Define *how to behave* - patterns, principles, and standards for your team
40
+ - **Skills** (`agents/skills/*/SKILL.md`): Define *how to execute specific tasks* - domain-specific workflows and specialized knowledge
41
+
42
+ ### Using Skills in Your AI Assistants
43
+
44
+ Skills can be referenced in all AI configuration files:
45
+
46
+ **In `.cursorrules` (Cursor IDE):**
47
+ ```
48
+ When the user asks about [domain], use the [skill-name] skill from agents/skills/
49
+ ```
50
+
51
+ **In `CLAUDE.md` (Claude):**
52
+ ```
53
+
54
+ When working on [domain-specific task], reference the [skill-name] skill in agents/skills/[skill-name]/SKILL.md
55
+ ```
56
+
57
+ **In `GEMINI.md` (Google Gemini):**
58
+ ```
59
+ When working on [domain-specific task], reference the [skill-name] skill in agents/skills/[skill-name]/SKILL.md
60
+ ```
61
+
62
+ **In `.github/copilot-instructions.md` (GitHub Copilot):**
63
+ ```
64
+ When helping with [domain-specific task], reference the [skill-name] skill from agents/skills/[skill-name]/SKILL.md
65
+ ```
66
+
67
+ All AI assistants support skill references. Create custom skills in `agents/skills/` to extend capabilities across your entire team.
41
68
 
42
69
  ## Getting Started
43
70
 
44
71
  1. Review AGENTS.md for AI assistance guidance
45
72
  2. Review ARCHITECTURE.md for overall project guidelines
46
- 3. Review AGENTS.MD for agent patterns
47
- 4. Adapt the rules to your specific technology stack
48
- 5. Configure your AI assistant (Cursor, Copilot, Claude, Gemini)
73
+ 3. Adapt the rules to your specific technology stack
74
+ 4. Create custom skills in `agents/skills/` for your domain
75
+ 5. Configure your AI assistants (Cursor, Copilot, Claude, Gemini) to reference your skills
49
76
 
50
77
  ## Documentation
51
78
 
@@ -0,0 +1,172 @@
1
+ # Agent Skills
2
+
3
+ This directory contains custom skills for your AI agents. Skills extend agent capabilities with specialized knowledge, workflows, and tools for specific domains.
4
+
5
+ ## What is a Skill?
6
+
7
+ A **skill** is a reusable module that:
8
+ - Defines domain-specific knowledge or workflows
9
+ - Extends agent capabilities for specialized tasks
10
+ - Can be shared across your project or published for others
11
+
12
+ **Rules** define *how to behave*; **Skills** define *how to execute specific tasks*.
13
+
14
+ ## Getting Started
15
+
16
+ ### Finding Existing Skills
17
+
18
+ Use the built-in `find-skills` skill to discover skills from the open ecosystem:
19
+
20
+ ```bash
21
+ npx skills find [query]
22
+ ```
23
+
24
+ Examples:
25
+ - `npx skills find react testing`
26
+ - `npx skills find deployment`
27
+ - `npx skills find accessibility`
28
+
29
+ Browse more at: https://skills.sh/
30
+
31
+ ### Creating a Custom Skill
32
+
33
+ To create a new skill for your specific domain:
34
+
35
+ 1. **Create a new folder** in this directory:
36
+ ```
37
+ agents/skills/my-custom-skill/
38
+ ```
39
+
40
+ 2. **Create a SKILL.md file** with metadata and instructions:
41
+ ```markdown
42
+ ---
43
+ name: my-custom-skill
44
+ description: Brief description of what this skill does
45
+ ---
46
+
47
+ # My Custom Skill
48
+
49
+ Instructions and examples for using this skill...
50
+ ```
51
+
52
+ 3. **Reference it** in your agent documentation or `.cursorrules`
53
+
54
+ ### Skill Structure
55
+
56
+ ```
57
+ agents/skills/
58
+ ├── find-skills/
59
+ │ └── SKILL.md # Meta-skill for discovering skills
60
+ ├── my-custom-skill/
61
+ │ └── SKILL.md # Your custom skill
62
+ └── README.md # This file
63
+ ```
64
+
65
+ ## Best Practices
66
+
67
+ 1. **Keep skills focused** - Each skill should handle one domain or workflow
68
+ 2. **Document clearly** - Include examples and use cases in SKILL.md
69
+ 3. **Name descriptively** - Use kebab-case names that reflect the skill's purpose
70
+ 4. **Version your skills** - Include version info in the metadata
71
+ 5. **Test before sharing** - Ensure skills work as documented
72
+
73
+ ## Common Skill Categories
74
+
75
+ Consider creating skills for:
76
+
77
+ | Category | Use Case |
78
+ | --------------- | ---------------------------------------- |
79
+ | Web Development | Framework-specific patterns and guidelines |
80
+ | Testing | Testing strategies and examples |
81
+ | DevOps | Deployment, CI/CD, infrastructure |
82
+ | Documentation | Doc generation, README templates |
83
+ | Code Quality | Code review, refactoring patterns |
84
+ | Design | UI/UX, accessibility, design systems |
85
+ | Productivity | Workflows, automation, git patterns |
86
+
87
+ ## Using Skills in Your Project
88
+
89
+ Skills can be referenced in all your AI assistant configuration files:
90
+
91
+ ### Cursor IDE (`.cursorrules`)
92
+ ```
93
+ When the user asks about [domain], use the [skill-name] skill from agents/skills/[skill-name]/SKILL.md
94
+ ```
95
+
96
+ ### Claude (`CLAUDE.md`)
97
+ ```markdown
98
+ ## When Working on [Domain]
99
+
100
+ Reference the [skill-name] skill in `agents/skills/[skill-name]/SKILL.md` for patterns and guidance.
101
+ ```
102
+
103
+ ### Google Gemini (`GEMINI.md`)
104
+ ```markdown
105
+ ## When Working on [Domain]
106
+
107
+ Reference the [skill-name] skill in `agents/skills/[skill-name]/SKILL.md` for patterns and guidance.
108
+ ```
109
+
110
+ ### GitHub Copilot (`.github/copilot-instructions.md`)
111
+ ```markdown
112
+ When helping with [domain-specific task], reference the [skill-name] skill from `agents/skills/[skill-name]/SKILL.md`
113
+ ```
114
+
115
+ ### Documentation (`AGENTS.md`)
116
+ ```markdown
117
+ - When working with [domain], see the [skill-name] skill in `agents/skills/[skill-name]/SKILL.md`
118
+ ```
119
+
120
+ **All AI assistants support skill references.** Keep your team aligned by linking to skill files across your configuration files.
121
+
122
+ 3. **Share with your team**:
123
+ - Commit to version control
124
+ - Document installation in your README
125
+
126
+ ## Example: Creating a Fastapi Skill
127
+
128
+ ```markdown
129
+ ---
130
+ name: fastapi-patterns
131
+ description: FastAPI development patterns and best practices for your projects
132
+ ---
133
+
134
+ # FastAPI Patterns
135
+
136
+ Use this skill when working with FastAPI projects.
137
+
138
+ ## Recommended Patterns
139
+
140
+ ### Request Validation
141
+ - Use Pydantic models for all request bodies
142
+ - Validate query parameters with proper typing
143
+
144
+ ### Error Handling
145
+ - Return meaningful HTTP status codes
146
+ - Document error responses in OpenAPI
147
+
148
+ ### Testing
149
+ - Use TestClient for API testing
150
+ - Mock external dependencies
151
+
152
+ ## Project Structure
153
+
154
+ ```
155
+ src/
156
+ ├── api/
157
+ │ ├── v1/
158
+ │ │ ├── users/
159
+ │ │ └── posts/
160
+ │ └── dependencies.py
161
+ ├── models/
162
+ ├── schemas/
163
+ ├── database/
164
+ └── main.py
165
+ ```
166
+ ```
167
+
168
+ ## Resources
169
+
170
+ - [Skills Documentation](https://skills.sh/)
171
+ - [Creating Skills Guide](https://skills.sh/docs/creating-skills)
172
+ - [Browse Popular Skills](https://skills.sh/explore)
@@ -0,0 +1,386 @@
1
+ ---
2
+ name: ui-ux-pro-max
3
+ description: "UI/UX design intelligence. 50 styles, 21 palettes, 50 font pairings, 20 charts, 9 stacks (React, Next.js, Vue, Svelte, SwiftUI, React Native, Flutter, Tailwind, shadcn/ui). Actions: plan, build, create, design, implement, review, fix, improve, optimize, enhance, refactor, check UI/UX code. Projects: website, landing page, dashboard, admin panel, e-commerce, SaaS, portfolio, blog, mobile app, .html, .tsx, .vue, .svelte. Elements: button, modal, navbar, sidebar, card, table, form, chart. Styles: glassmorphism, claymorphism, minimalism, brutalism, neumorphism, bento grid, dark mode, responsive, skeuomorphism, flat design. Topics: color palette, accessibility, animation, layout, typography, font pairing, spacing, hover, shadow, gradient. Integrations: shadcn/ui MCP for component search and examples."
4
+ ---
5
+
6
+ # UI/UX Pro Max - Design Intelligence
7
+
8
+ Comprehensive design guide for web and mobile applications. Contains 50+ styles, 97 color palettes, 57 font pairings, 99 UX guidelines, and 25 chart types across 9 technology stacks. Searchable database with priority-based recommendations.
9
+
10
+ ## When to Apply
11
+
12
+ Reference these guidelines when:
13
+ - Designing new UI components or pages
14
+ - Choosing color palettes and typography
15
+ - Reviewing code for UX issues
16
+ - Building landing pages or dashboards
17
+ - Implementing accessibility requirements
18
+
19
+ ## Rule Categories by Priority
20
+
21
+ | Priority | Category | Impact | Domain |
22
+ |----------|----------|--------|--------|
23
+ | 1 | Accessibility | CRITICAL | `ux` |
24
+ | 2 | Touch & Interaction | CRITICAL | `ux` |
25
+ | 3 | Performance | HIGH | `ux` |
26
+ | 4 | Layout & Responsive | HIGH | `ux` |
27
+ | 5 | Typography & Color | MEDIUM | `typography`, `color` |
28
+ | 6 | Animation | MEDIUM | `ux` |
29
+ | 7 | Style Selection | MEDIUM | `style`, `product` |
30
+ | 8 | Charts & Data | LOW | `chart` |
31
+
32
+ ## Quick Reference
33
+
34
+ ### 1. Accessibility (CRITICAL)
35
+
36
+ - `color-contrast` - Minimum 4.5:1 ratio for normal text
37
+ - `focus-states` - Visible focus rings on interactive elements
38
+ - `alt-text` - Descriptive alt text for meaningful images
39
+ - `aria-labels` - aria-label for icon-only buttons
40
+ - `keyboard-nav` - Tab order matches visual order
41
+ - `form-labels` - Use label with for attribute
42
+
43
+ ### 2. Touch & Interaction (CRITICAL)
44
+
45
+ - `touch-target-size` - Minimum 44x44px touch targets
46
+ - `hover-vs-tap` - Use click/tap for primary interactions
47
+ - `loading-buttons` - Disable button during async operations
48
+ - `error-feedback` - Clear error messages near problem
49
+ - `cursor-pointer` - Add cursor-pointer to clickable elements
50
+
51
+ ### 3. Performance (HIGH)
52
+
53
+ - `image-optimization` - Use WebP, srcset, lazy loading
54
+ - `reduced-motion` - Check prefers-reduced-motion
55
+ - `content-jumping` - Reserve space for async content
56
+
57
+ ### 4. Layout & Responsive (HIGH)
58
+
59
+ - `viewport-meta` - width=device-width initial-scale=1
60
+ - `readable-font-size` - Minimum 16px body text on mobile
61
+ - `horizontal-scroll` - Ensure content fits viewport width
62
+ - `z-index-management` - Define z-index scale (10, 20, 30, 50)
63
+
64
+ ### 5. Typography & Color (MEDIUM)
65
+
66
+ - `line-height` - Use 1.5-1.75 for body text
67
+ - `line-length` - Limit to 65-75 characters per line
68
+ - `font-pairing` - Match heading/body font personalities
69
+
70
+ ### 6. Animation (MEDIUM)
71
+
72
+ - `duration-timing` - Use 150-300ms for micro-interactions
73
+ - `transform-performance` - Use transform/opacity, not width/height
74
+ - `loading-states` - Skeleton screens or spinners
75
+
76
+ ### 7. Style Selection (MEDIUM)
77
+
78
+ - `style-match` - Match style to product type
79
+ - `consistency` - Use same style across all pages
80
+ - `no-emoji-icons` - Use SVG icons, not emojis
81
+
82
+ ### 8. Charts & Data (LOW)
83
+
84
+ - `chart-type` - Match chart type to data type
85
+ - `color-guidance` - Use accessible color palettes
86
+ - `data-table` - Provide table alternative for accessibility
87
+
88
+ ## How to Use
89
+
90
+ Search specific domains using the CLI tool below.
91
+
92
+ ---
93
+
94
+ ## Prerequisites
95
+
96
+ Check if Python is installed:
97
+
98
+ ```bash
99
+ python3 --version || python --version
100
+ ```
101
+
102
+ If Python is not installed, install it based on user's OS:
103
+
104
+ **macOS:**
105
+ ```bash
106
+ brew install python3
107
+ ```
108
+
109
+ **Ubuntu/Debian:**
110
+ ```bash
111
+ sudo apt update && sudo apt install python3
112
+ ```
113
+
114
+ **Windows:**
115
+ ```powershell
116
+ winget install Python.Python.3.12
117
+ ```
118
+
119
+ ---
120
+
121
+ ## How to Use This Skill
122
+
123
+ When user requests UI/UX work (design, build, create, implement, review, fix, improve), follow this workflow:
124
+
125
+ ### Step 1: Analyze User Requirements
126
+
127
+ Extract key information from user request:
128
+ - **Product type**: SaaS, e-commerce, portfolio, dashboard, landing page, etc.
129
+ - **Style keywords**: minimal, playful, professional, elegant, dark mode, etc.
130
+ - **Industry**: healthcare, fintech, gaming, education, etc.
131
+ - **Stack**: React, Vue, Next.js, or default to `html-tailwind`
132
+
133
+ ### Step 2: Generate Design System (REQUIRED)
134
+
135
+ **Always start with `--design-system`** to get comprehensive recommendations with reasoning:
136
+
137
+ ```bash
138
+ python3 skills/ui-ux-pro-max/scripts/search.py "<product_type> <industry> <keywords>" --design-system [-p "Project Name"]
139
+ ```
140
+
141
+ This command:
142
+ 1. Searches 5 domains in parallel (product, style, color, landing, typography)
143
+ 2. Applies reasoning rules from `ui-reasoning.csv` to select best matches
144
+ 3. Returns complete design system: pattern, style, colors, typography, effects
145
+ 4. Includes anti-patterns to avoid
146
+
147
+ **Example:**
148
+ ```bash
149
+ python3 skills/ui-ux-pro-max/scripts/search.py "beauty spa wellness service" --design-system -p "Serenity Spa"
150
+ ```
151
+
152
+ ### Step 2b: Persist Design System (Master + Overrides Pattern)
153
+
154
+ To save the design system for **hierarchical retrieval across sessions**, add `--persist`:
155
+
156
+ ```bash
157
+ python3 skills/ui-ux-pro-max/scripts/search.py "<query>" --design-system --persist -p "Project Name"
158
+ ```
159
+
160
+ This creates:
161
+ - `design-system/MASTER.md` — Global Source of Truth with all design rules
162
+ - `design-system/pages/` — Folder for page-specific overrides
163
+
164
+ **With page-specific override:**
165
+ ```bash
166
+ python3 skills/ui-ux-pro-max/scripts/search.py "<query>" --design-system --persist -p "Project Name" --page "dashboard"
167
+ ```
168
+
169
+ This also creates:
170
+ - `design-system/pages/dashboard.md` — Page-specific deviations from Master
171
+
172
+ **How hierarchical retrieval works:**
173
+ 1. When building a specific page (e.g., "Checkout"), first check `design-system/pages/checkout.md`
174
+ 2. If the page file exists, its rules **override** the Master file
175
+ 3. If not, use `design-system/MASTER.md` exclusively
176
+
177
+ **Context-aware retrieval prompt:**
178
+ ```
179
+ I am building the [Page Name] page. Please read design-system/MASTER.md.
180
+ Also check if design-system/pages/[page-name].md exists.
181
+ If the page file exists, prioritize its rules.
182
+ If not, use the Master rules exclusively.
183
+ Now, generate the code...
184
+ ```
185
+
186
+ ### Step 3: Supplement with Detailed Searches (as needed)
187
+
188
+ After getting the design system, use domain searches to get additional details:
189
+
190
+ ```bash
191
+ python3 skills/ui-ux-pro-max/scripts/search.py "<keyword>" --domain <domain> [-n <max_results>]
192
+ ```
193
+
194
+ **When to use detailed searches:**
195
+
196
+ | Need | Domain | Example |
197
+ |------|--------|---------|
198
+ | More style options | `style` | `--domain style "glassmorphism dark"` |
199
+ | Chart recommendations | `chart` | `--domain chart "real-time dashboard"` |
200
+ | UX best practices | `ux` | `--domain ux "animation accessibility"` |
201
+ | Alternative fonts | `typography` | `--domain typography "elegant luxury"` |
202
+ | Landing structure | `landing` | `--domain landing "hero social-proof"` |
203
+
204
+ ### Step 4: Stack Guidelines (Default: html-tailwind)
205
+
206
+ Get implementation-specific best practices. If user doesn't specify a stack, **default to `html-tailwind`**.
207
+
208
+ ```bash
209
+ python3 skills/ui-ux-pro-max/scripts/search.py "<keyword>" --stack html-tailwind
210
+ ```
211
+
212
+ Available stacks: `html-tailwind`, `react`, `nextjs`, `vue`, `svelte`, `swiftui`, `react-native`, `flutter`, `shadcn`, `jetpack-compose`
213
+
214
+ ---
215
+
216
+ ## Search Reference
217
+
218
+ ### Available Domains
219
+
220
+ | Domain | Use For | Example Keywords |
221
+ |--------|---------|------------------|
222
+ | `product` | Product type recommendations | SaaS, e-commerce, portfolio, healthcare, beauty, service |
223
+ | `style` | UI styles, colors, effects | glassmorphism, minimalism, dark mode, brutalism |
224
+ | `typography` | Font pairings, Google Fonts | elegant, playful, professional, modern |
225
+ | `color` | Color palettes by product type | saas, ecommerce, healthcare, beauty, fintech, service |
226
+ | `landing` | Page structure, CTA strategies | hero, hero-centric, testimonial, pricing, social-proof |
227
+ | `chart` | Chart types, library recommendations | trend, comparison, timeline, funnel, pie |
228
+ | `ux` | Best practices, anti-patterns | animation, accessibility, z-index, loading |
229
+ | `react` | React/Next.js performance | waterfall, bundle, suspense, memo, rerender, cache |
230
+ | `web` | Web interface guidelines | aria, focus, keyboard, semantic, virtualize |
231
+ | `prompt` | AI prompts, CSS keywords | (style name) |
232
+
233
+ ### Available Stacks
234
+
235
+ | Stack | Focus |
236
+ |-------|-------|
237
+ | `html-tailwind` | Tailwind utilities, responsive, a11y (DEFAULT) |
238
+ | `react` | State, hooks, performance, patterns |
239
+ | `nextjs` | SSR, routing, images, API routes |
240
+ | `vue` | Composition API, Pinia, Vue Router |
241
+ | `svelte` | Runes, stores, SvelteKit |
242
+ | `swiftui` | Views, State, Navigation, Animation |
243
+ | `react-native` | Components, Navigation, Lists |
244
+ | `flutter` | Widgets, State, Layout, Theming |
245
+ | `shadcn` | shadcn/ui components, theming, forms, patterns |
246
+ | `jetpack-compose` | Composables, Modifiers, State Hoisting, Recomposition |
247
+
248
+ ---
249
+
250
+ ## Example Workflow
251
+
252
+ **User request:** "Làm landing page cho dịch vụ chăm sóc da chuyên nghiệp"
253
+
254
+ ### Step 1: Analyze Requirements
255
+ - Product type: Beauty/Spa service
256
+ - Style keywords: elegant, professional, soft
257
+ - Industry: Beauty/Wellness
258
+ - Stack: html-tailwind (default)
259
+
260
+ ### Step 2: Generate Design System (REQUIRED)
261
+
262
+ ```bash
263
+ python3 skills/ui-ux-pro-max/scripts/search.py "beauty spa wellness service elegant" --design-system -p "Serenity Spa"
264
+ ```
265
+
266
+ **Output:** Complete design system with pattern, style, colors, typography, effects, and anti-patterns.
267
+
268
+ ### Step 3: Supplement with Detailed Searches (as needed)
269
+
270
+ ```bash
271
+ # Get UX guidelines for animation and accessibility
272
+ python3 skills/ui-ux-pro-max/scripts/search.py "animation accessibility" --domain ux
273
+
274
+ # Get alternative typography options if needed
275
+ python3 skills/ui-ux-pro-max/scripts/search.py "elegant luxury serif" --domain typography
276
+ ```
277
+
278
+ ### Step 4: Stack Guidelines
279
+
280
+ ```bash
281
+ python3 skills/ui-ux-pro-max/scripts/search.py "layout responsive form" --stack html-tailwind
282
+ ```
283
+
284
+ **Then:** Synthesize design system + detailed searches and implement the design.
285
+
286
+ ---
287
+
288
+ ## Output Formats
289
+
290
+ The `--design-system` flag supports two output formats:
291
+
292
+ ```bash
293
+ # ASCII box (default) - best for terminal display
294
+ python3 skills/ui-ux-pro-max/scripts/search.py "fintech crypto" --design-system
295
+
296
+ # Markdown - best for documentation
297
+ python3 skills/ui-ux-pro-max/scripts/search.py "fintech crypto" --design-system -f markdown
298
+ ```
299
+
300
+ ---
301
+
302
+ ## Tips for Better Results
303
+
304
+ 1. **Be specific with keywords** - "healthcare SaaS dashboard" > "app"
305
+ 2. **Search multiple times** - Different keywords reveal different insights
306
+ 3. **Combine domains** - Style + Typography + Color = Complete design system
307
+ 4. **Always check UX** - Search "animation", "z-index", "accessibility" for common issues
308
+ 5. **Use stack flag** - Get implementation-specific best practices
309
+ 6. **Iterate** - If first search doesn't match, try different keywords
310
+
311
+ ---
312
+
313
+ ## Common Rules for Professional UI
314
+
315
+ These are frequently overlooked issues that make UI look unprofessional:
316
+
317
+ ### Icons & Visual Elements
318
+
319
+ | Rule | Do | Don't |
320
+ |------|----|----- |
321
+ | **No emoji icons** | Use SVG icons (Heroicons, Lucide, Simple Icons) | Use emojis like 🎨 🚀 ⚙️ as UI icons |
322
+ | **Stable hover states** | Use color/opacity transitions on hover | Use scale transforms that shift layout |
323
+ | **Correct brand logos** | Research official SVG from Simple Icons | Guess or use incorrect logo paths |
324
+ | **Consistent icon sizing** | Use fixed viewBox (24x24) with w-6 h-6 | Mix different icon sizes randomly |
325
+
326
+ ### Interaction & Cursor
327
+
328
+ | Rule | Do | Don't |
329
+ |------|----|----- |
330
+ | **Cursor pointer** | Add `cursor-pointer` to all clickable/hoverable cards | Leave default cursor on interactive elements |
331
+ | **Hover feedback** | Provide visual feedback (color, shadow, border) | No indication element is interactive |
332
+ | **Smooth transitions** | Use `transition-colors duration-200` | Instant state changes or too slow (>500ms) |
333
+
334
+ ### Light/Dark Mode Contrast
335
+
336
+ | Rule | Do | Don't |
337
+ |------|----|----- |
338
+ | **Glass card light mode** | Use `bg-white/80` or higher opacity | Use `bg-white/10` (too transparent) |
339
+ | **Text contrast light** | Use `#0F172A` (slate-900) for text | Use `#94A3B8` (slate-400) for body text |
340
+ | **Muted text light** | Use `#475569` (slate-600) minimum | Use gray-400 or lighter |
341
+ | **Border visibility** | Use `border-gray-200` in light mode | Use `border-white/10` (invisible) |
342
+
343
+ ### Layout & Spacing
344
+
345
+ | Rule | Do | Don't |
346
+ |------|----|----- |
347
+ | **Floating navbar** | Add `top-4 left-4 right-4` spacing | Stick navbar to `top-0 left-0 right-0` |
348
+ | **Content padding** | Account for fixed navbar height | Let content hide behind fixed elements |
349
+ | **Consistent max-width** | Use same `max-w-6xl` or `max-w-7xl` | Mix different container widths |
350
+
351
+ ---
352
+
353
+ ## Pre-Delivery Checklist
354
+
355
+ Before delivering UI code, verify these items:
356
+
357
+ ### Visual Quality
358
+ - [ ] No emojis used as icons (use SVG instead)
359
+ - [ ] All icons from consistent icon set (Heroicons/Lucide)
360
+ - [ ] Brand logos are correct (verified from Simple Icons)
361
+ - [ ] Hover states don't cause layout shift
362
+ - [ ] Use theme colors directly (bg-primary) not var() wrapper
363
+
364
+ ### Interaction
365
+ - [ ] All clickable elements have `cursor-pointer`
366
+ - [ ] Hover states provide clear visual feedback
367
+ - [ ] Transitions are smooth (150-300ms)
368
+ - [ ] Focus states visible for keyboard navigation
369
+
370
+ ### Light/Dark Mode
371
+ - [ ] Light mode text has sufficient contrast (4.5:1 minimum)
372
+ - [ ] Glass/transparent elements visible in light mode
373
+ - [ ] Borders visible in both modes
374
+ - [ ] Test both modes before delivery
375
+
376
+ ### Layout
377
+ - [ ] Floating elements have proper spacing from edges
378
+ - [ ] No content hidden behind fixed navbars
379
+ - [ ] Responsive at 375px, 768px, 1024px, 1440px
380
+ - [ ] No horizontal scroll on mobile
381
+
382
+ ### Accessibility
383
+ - [ ] All images have alt text
384
+ - [ ] Form inputs have labels
385
+ - [ ] Color is not the only indicator
386
+ - [ ] `prefers-reduced-motion` respected
@@ -1,39 +0,0 @@
1
- ---
2
- name: web-design-guidelines
3
- 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".
4
- metadata:
5
- author: vercel
6
- version: "1.0.0"
7
- argument-hint: <file-or-pattern>
8
- ---
9
-
10
- # Web Interface Guidelines
11
-
12
- Review files for compliance with Web Interface Guidelines.
13
-
14
- ## How It Works
15
-
16
- 1. Fetch the latest guidelines from the source URL below
17
- 2. Read the specified files (or prompt user for files/pattern)
18
- 3. Check against all rules in the fetched guidelines
19
- 4. Output findings in the terse `file:line` format
20
-
21
- ## Guidelines Source
22
-
23
- Fetch fresh guidelines before each review:
24
-
25
- ```
26
- https://raw.githubusercontent.com/vercel-labs/web-interface-guidelines/main/command.md
27
- ```
28
-
29
- Use WebFetch to retrieve the latest rules. The fetched content contains all the rules and output format instructions.
30
-
31
- ## Usage
32
-
33
- When a user provides a file or pattern argument:
34
- 1. Fetch guidelines from the source URL above
35
- 2. Read the specified files
36
- 3. Apply all rules from the fetched guidelines
37
- 4. Output findings using the format specified in the guidelines
38
-
39
- If no files specified, ask the user which files to review.