Skip to content

Commit 79b4db3

Browse files
committed
docs: add SKILL.md for AI coding assistants
1 parent c67a3ba commit 79b4db3

File tree

5 files changed

+342
-22
lines changed

5 files changed

+342
-22
lines changed

apps/docs/build/copy-markdown.ts

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { copyFileSync, mkdirSync } from 'node:fs'
1+
import { copyFileSync, existsSync, mkdirSync } from 'node:fs'
22
import { glob } from 'node:fs/promises'
33
import { dirname, join, relative } from 'node:path'
44

@@ -21,7 +21,15 @@ export default function copyMarkdownPlugin (): Plugin {
2121
copyFileSync(file, destPath)
2222
}
2323

24-
console.log(`[copy-markdown] Copied ${files.length} markdown files`)
24+
// Copy SKILL.md from packages/0 to dist root
25+
const skillSrc = '../../packages/0/SKILL.md'
26+
const skillDest = join(outDir, 'SKILL.md')
27+
if (existsSync(skillSrc)) {
28+
copyFileSync(skillSrc, skillDest)
29+
console.log(`[copy-markdown] Copied ${files.length} markdown files + SKILL.md`)
30+
} else {
31+
console.log(`[copy-markdown] Copied ${files.length} markdown files (SKILL.md not found)`)
32+
}
2533
},
2634
}
2735
}

apps/docs/build/generate-llms-full.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -226,6 +226,9 @@ function generateLlmsTxt (pages: PageInfo[]): string {
226226
lines.push('')
227227
}
228228

229+
// AI Resources section
230+
lines.push('## AI Resources', '', `- [SKILL.md](${BASE_URL}/SKILL.md): Compact reference with patterns, anti-patterns, and TypeScript types for AI coding assistants`, `- [Vuetify MCP](${BASE_URL}/guide/tooling/vuetify-mcp): Model Context Protocol server for structured API access`, '')
231+
229232
return lines.join('\n')
230233
}
231234

apps/docs/src/pages/guide/tooling/ai-tools.md

Lines changed: 35 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -31,37 +31,52 @@ v0 provides machine-readable documentation files following the [llms.txt](https:
3131
| - | - | - | - |
3232
| <a href="/llms.txt" target="_blank" class="v0-link">llms.txt↗</a> | {{ llmsStats.llms.sizeFormatted }} | Curated index with links | Quick context, navigation |
3333
| <a href="/llms-full.txt" target="_blank" class="v0-link whitespace-nowrap">llms-full.txt↗</a> | {{ llmsStats.llmsFull.sizeFormatted }} | Complete documentation | Deep understanding, code generation |
34+
| <a href="/SKILL.md" target="_blank" class="v0-link">SKILL.md↗</a> | ~7KB | Patterns & anti-patterns | Claude Code, Clawdbot skills |
3435

3536
> [!ASKAI] When should I use llms.txt vs llms-full.txt?
3637
37-
## Usage Examples
38+
## Usage
3839

39-
### ChatGPT / Claude.ai
40+
Whether you're a developer prompting an AI assistant or an agent consuming v0 documentation programmatically, choose the approach that fits your workflow.
4041

41-
Paste the URL directly in chat:
42+
::: code-group
4243

43-
```txt
44-
Read https://0.vuetifyjs.com/llms-full.txt and help me build a multi-select dropdown using v0 composables.
45-
```
46-
47-
### Cursor / Windsurf
44+
```md I'm a Human
45+
**Claude Code / Codex** — Add Vuetify MCP for structured API access:
46+
> claude mcp add --transport http vuetify-mcp https://mcp.vuetifyjs.com/mcp
4847
49-
Add to your project's `.cursorrules` or AI context:
48+
Or fetch docs directly in your session:
49+
> WebFetch https://0.vuetifyjs.com/llms-full.txt
5050
51-
```txt
52-
@https://0.vuetifyjs.com/llms.txt
53-
```
51+
**Cursor / Windsurf** — Add to .cursorrules or configure MCP:
52+
> @https://0.vuetifyjs.com/llms.txt
5453
55-
### Claude Code
54+
See [Vuetify MCP](/guide/tooling/vuetify-mcp) for IDE configuration.
5655

57-
Fetch the documentation in your session:
56+
**ChatGPT / Claude.ai** — Paste the URL in chat:
57+
> Read https://0.vuetifyjs.com/llms-full.txt and help me build a multi-select dropdown.
58+
```
5859

59-
```txt
60-
WebFetch https://0.vuetifyjs.com/llms-full.txt
60+
```md I'm an Agent
61+
**With MCP (recommended)** — Always-current structured access:
62+
- `get_vuetify0_skill` — Latest SKILL.md reference
63+
- `get_vuetify0_composable_list` — Browse all composables
64+
- `get_vuetify0_composable_guide` — Detailed composable docs
65+
- `get_vuetify0_component_list` — Browse headless components
66+
- `get_vuetify0_component_guide` — Component docs and examples
67+
68+
**Without MCP** — Fetch SKILL.md at session start:
69+
> WebFetch https://0.vuetifyjs.com/SKILL.md
70+
71+
**What's in SKILL.md:**
72+
- Core composables (useTheme, useLocale, useBreakpoints, etc.)
73+
- Selection system (useSingle, useGroup, useStep)
74+
- Component compound patterns (Root/Item pairs)
75+
- Registry & Trinity patterns
76+
- Common mistakes to avoid
6177
```
6278

63-
> [!TIP]
64-
> For the best experience with Claude, use [Vuetify MCP](/guide/tooling/vuetify-mcp) instead. It provides structured API access rather than raw text.
79+
:::
6580

6681
## What's Included
6782

@@ -74,6 +89,8 @@ WebFetch https://0.vuetifyjs.com/llms-full.txt
7489

7590
**llms-full.txt** includes the complete content of every documentation page, stripped of Vue components and frontmatter for cleaner LLM consumption.
7691

92+
**SKILL.md** is a compact reference optimized for AI coding assistants. It focuses on practical usage patterns, the selection/registry systems, common mistakes, and TypeScript integration — ideal for project-level context files.
93+
7794
## How It Works
7895

7996
Both files are auto-generated at build time by [generate-llms-full.ts](https://github.com/vuetifyjs/0/blob/master/apps/docs/build/generate-llms-full.ts):

0 commit comments

Comments
 (0)