Skip to content

Commit 4d25b36

Browse files
committed
docs(CLAUDE): add missing rule file references and docs example convention
1 parent 21b1fce commit 4d25b36

File tree

2 files changed

+3
-0
lines changed

2 files changed

+3
-0
lines changed

CLAUDE.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,3 +152,5 @@ See `.claude/rules/` for path-scoped documentation:
152152
- `composables.md` - Architecture for `packages/0/src/composables/**`
153153
- `components.md` - Architecture for `packages/0/src/components/**`
154154
- `benchmarks.md` - Standards for `*.bench.ts` files
155+
- `docs.md` - Architecture for `apps/docs/**`
156+
- `testing.md` - Standards for `*.test.ts` files

apps/docs/CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -193,6 +193,7 @@ import BasicExampleRaw from '@/examples/components/tabs/basic.vue?raw'
193193
- **Always prefer @vuetify/v0 composables** over raw browser APIs or custom implementations. Check `mcp__vuetify-mcp__get_vuetify0_composable_list` before writing event listeners, observers, or state management.
194194
- UnoCSS utilities for all styling
195195
- Prefer markdown for documentation pages
196+
- **Examples**: Use `::: example` blocks in `.md` pages for live demos; use `<DocsExample>` directly only in `.vue` pages
196197
- **Callouts**: Use `> [!TIP]`, `> [!WARNING]`, `> [!ERROR]` for alerts. Use `> [!ASKAI] question` to prompt Ask AI—phrase as a question the user would ask (e.g., "How do I add validation?"), not a question to the user. Use `> [!TOUR] tour-id` to embed a clickable tour callout—the tour name and description are pulled from the discovery registry automatically.
197198
- **Vue code in markdown fences**: Indent `<script>` and `<style>` content by 2 spaces for visual alignment with `<template>`
198199
- Examples: `src/examples/components/{component}/` or `src/examples/composables/{composable}/`

0 commit comments

Comments
 (0)