From 3c4c3a81673b49e1060e7536ee89a758d5d42dcc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pedro=20Proen=C3=A7a?= <8202400+pproenca@users.noreply.github.com> Date: Sat, 7 Mar 2026 21:55:51 +0000 Subject: [PATCH] docs: align curated skill READMEs with references layout --- skills/.curated/ui-design/README.md | 30 +++++++++++++++-------------- skills/.curated/vitest/README.md | 25 ++++++++++++------------ 2 files changed, 29 insertions(+), 26 deletions(-) diff --git a/skills/.curated/ui-design/README.md b/skills/.curated/ui-design/README.md index 5bbdf9c1..8f9fd486 100644 --- a/skills/.curated/ui-design/README.md +++ b/skills/.curated/ui-design/README.md @@ -23,16 +23,18 @@ ui-ux-frontend-design/ ├── AGENTS.md # Full compiled guide ├── metadata.json # Version and references ├── README.md # This file -└── rules/ - ├── _sections.md # Category definitions - ├── access-*.md # Accessibility rules (7) - ├── cwv-*.md # Core Web Vitals rules (6) - ├── layout-*.md # Layout rules (6) - ├── resp-*.md # Responsive design rules (5) - ├── typo-*.md # Typography rules (5) - ├── color-*.md # Color rules (4) - ├── form-*.md # Form rules (5) - └── anim-*.md # Animation rules (4) +├── references/ +│ ├── _sections.md # Category definitions +│ ├── access-*.md # Accessibility rules (7) +│ ├── cwv-*.md # Core Web Vitals rules (6) +│ ├── layout-*.md # Layout rules (6) +│ ├── resp-*.md # Responsive design rules (5) +│ ├── typo-*.md # Typography rules (5) +│ ├── color-*.md # Color rules (4) +│ ├── form-*.md # Form rules (5) +│ └── anim-*.md # Animation rules (4) +└── assets/templates/ + └── _template.md # Rule template ``` ## Getting Started @@ -41,7 +43,7 @@ ui-ux-frontend-design/ # Install dependencies (from repo root) pnpm install -# Build AGENTS.md from rules +# Build AGENTS.md from references pnpm build # Validate skill structure @@ -50,8 +52,8 @@ pnpm validate ## Creating a New Rule -1. Choose the appropriate category from `rules/_sections.md` -2. Create a new file: `rules/{prefix}-{description}.md` +1. Choose the appropriate category from `references/_sections.md` +2. Create a new file: `references/{prefix}-{description}.md` 3. Use the template structure (see below) 4. Run `pnpm build` to regenerate AGENTS.md 5. Run `pnpm validate` to check for errors @@ -102,7 +104,7 @@ Reference: [Link](url) Rules follow the pattern: `{prefix}-{description}.md` -- `prefix`: Category identifier (3-8 chars) from _sections.md +- `prefix`: Category identifier (3-8 chars) from `references/_sections.md` - `description`: Kebab-case description of the rule Examples: diff --git a/skills/.curated/vitest/README.md b/skills/.curated/vitest/README.md index de11b537..c007e701 100644 --- a/skills/.curated/vitest/README.md +++ b/skills/.curated/vitest/README.md @@ -27,17 +27,18 @@ vitest/ ├── AGENTS.md # Compiled comprehensive guide ├── metadata.json # Version and references ├── README.md # This file -└── rules/ - ├── _sections.md # Category definitions - ├── _template.md # Rule template - ├── async-*.md # Async pattern rules - ├── setup-*.md # Setup and isolation rules - ├── mock-*.md # Mocking pattern rules - ├── perf-*.md # Performance rules - ├── snap-*.md # Snapshot rules - ├── env-*.md # Environment rules - ├── assert-*.md # Assertion rules - └── org-*.md # Organization rules +├── references/ +│ ├── _sections.md # Category definitions +│ ├── async-*.md # Async pattern rules +│ ├── setup-*.md # Setup and isolation rules +│ ├── mock-*.md # Mocking pattern rules +│ ├── perf-*.md # Performance rules +│ ├── snap-*.md # Snapshot rules +│ ├── env-*.md # Environment rules +│ ├── assert-*.md # Assertion rules +│ └── org-*.md # Organization rules +└── assets/templates/ + └── _template.md # Rule template ``` ## Usage @@ -48,7 +49,7 @@ Reference `SKILL.md` for quick navigation or `AGENTS.md` for the complete compil ### For Humans -Browse individual rule files in the `rules/` directory for detailed explanations and code examples. +Browse individual rule files in the `references/` directory for detailed explanations and code examples. ## Key Patterns