Skip to content

Commit d1180fa

Browse files
committed
Update CLAUDE.md
1 parent 9df4caa commit d1180fa

1 file changed

Lines changed: 58 additions & 1 deletion

File tree

CLAUDE.md

Lines changed: 58 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,61 @@
1-
# Гайдлайн по переводу документации
1+
# Testo Documentation
2+
3+
**Testo** - extensible PHP testing framework. Tests without TestCase inheritance, middleware architecture, PSR-14 events, separate Assert/Expect facades.
4+
5+
## Structure
6+
7+
```
8+
docs/ # English (root)
9+
├── index.md # Home page
10+
├── docs/ # Documentation pages
11+
└── .vitepress/
12+
├── config.mts # Config: nav, sidebar, locales
13+
└── theme/style.css # Custom styles (dough colors)
14+
15+
ru/ # Russian locale (same structure)
16+
```
17+
18+
## Style Guide
19+
20+
**Tone:** Informal but technically accurate. Code examples over explanations.
21+
22+
**Home page rules:**
23+
- DON'T show code in features (text only, 1 sentence each)
24+
- Don't mention competitors, use "old solutions"
25+
26+
**Markdown:** Use `::: tip`, `::: warning`, `::: info` blocks
27+
28+
## Working with Content
29+
30+
**Adding pages:**
31+
1. Create both `docs/page.md` (EN) and `ru/docs/page.md` (RU)
32+
2. Add to sidebar in `.vitepress/config.mts` for both locales
33+
3. Internal links: `./page` or `/docs/page` (no `.html`)
34+
35+
**Dead links:** Create stub with `::: tip Coming Soon` block
36+
37+
**Styles:** `.vitepress/theme/style.css` - brand colors `--vp-c-brand-1`, responsive breakpoints 960px/640px
38+
39+
## VitePress Commands
40+
41+
```bash
42+
npm run docs:dev # Dev server at localhost:5173
43+
npm run docs:build # Build to .vitepress/dist/
44+
npm run docs:preview # Preview build
45+
```
46+
47+
## Configuration
48+
49+
**File:** `.vitepress/config.mts`
50+
51+
- `locales`: root (EN) + `ru` (RU) with separate nav/sidebar
52+
- `cleanUrls: true`, `lastUpdated: true`, `search.provider: 'local'`
53+
- Nav and Sidebar defined in `themeConfig` for each locale
54+
- Sidebar sections: Introduction, Guide, Customization
55+
56+
---
57+
58+
# Гайдлайн по переводу документации на Русский язык
259

360
## Основные принципы
461

0 commit comments

Comments
 (0)