Skip to content

Commit 89962dd

Browse files
committed
chore: add documentation workflow skill
1 parent 42c6b64 commit 89962dd

4 files changed

Lines changed: 69 additions & 0 deletions

File tree

.agents/skills/architecture-standards/SKILL.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,8 @@ description: Use when working in massCode and you need repo-wide architecture ru
6161
`spaces-architecture`
6262
- i18n, locale keys, `i18n.t(...)`:
6363
`i18n`
64+
- docs website, docs sidebar, скриншоты, README-упоминания фич:
65+
`documentation-workflow`
6466
- scoped lint/test и follow-up commands:
6567
`development-workflow`
6668

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
name: documentation-workflow
3+
description: Use when adding or updating massCode documentation, documenting a new feature, changing docs website pages, adding docs assets, updating the VitePress sidebar, or adding README feature mentions.
4+
---
5+
6+
# Documentation Workflow
7+
8+
## Overview
9+
10+
Документация massCode живёт в VitePress сайте в `docs/website/documentation`. README — это общий обзор проекта, а не источник детального описания фич.
11+
12+
## Documentation Surfaces
13+
14+
- Документация фич: `docs/website/documentation/**`
15+
- Sidebar документации: `docs/website/.vitepress/config.mts`
16+
- Assets документации: `docs/website/public/**`
17+
- Overview документации: `docs/website/documentation/index.md`
18+
- Overview проекта: `README.md`
19+
20+
## Core Rules
21+
22+
- Проверяй поведение фичи в коде или существующей документации; не документируй по памяти.
23+
- Используй `rg`, чтобы найти связанные страницы, скриншоты, shortcuts, labels и существующие формулировки.
24+
- Если целевая версия известна, используй именно её. Если версия неизвестна, не придумывай её.
25+
- Пользовательская документация сайта пишется на английском, в стиле существующих docs pages.
26+
- Добавляй или обновляй наиболее конкретную страницу в `docs/website/documentation`.
27+
- Для новых страниц используй frontmatter с `title` и `description`.
28+
- Если фича доступна только с конкретного релиза, добавляй `<AppVersion text=">=x.y" />` ближе к началу страницы.
29+
- Добавляй страницу в `docs/website/.vitepress/config.mts` только если она должна появиться в навигации.
30+
- Ссылайся из `docs/website/documentation/index.md` только на широкие, cross-cutting фичи.
31+
- Пиши короткими task-oriented секциями. Предпочитай пользовательские флоу, а не детали реализации.
32+
- Shortcuts документируй через `<kbd>...</kbd>` и указывай macOS плюс Windows/Linux варианты, если они отличаются.
33+
34+
## Images And Assets Rules
35+
36+
- Картинки для docs клади в `docs/website/public`.
37+
- Ссылайся на картинки через `withBase`, например:
38+
`<img :src="withBase('/feature.png')">`
39+
- Если страница использует `withBase`, добавь соответствующий script block:
40+
`import { withBase } from 'vitepress'`
41+
- Используй скриншоты только когда они реально объясняют фичу. Не добавляй декоративные изображения.
42+
43+
## README Rules
44+
45+
- Добавляй README-упоминания только для user-facing фич, которые важны на уровне общего обзора проекта.
46+
- Держи README copy коротким и product-level; подробное использование должно быть в `docs/website/documentation`.
47+
- Не пиши в README, когда фича была добавлена. Version availability должна жить в docs pages или release notes.
48+
- Не ставь новую фичу первой автоматически. Сохраняй текущую информационную архитектуру: сначала основные spaces/features, затем широкие workflow helpers, если пользователь не попросил иначе.
49+
50+
## Validation
51+
52+
- Запускай `git diff --check`.
53+
- Для изменений docs website запускай `pnpm -C docs/website build`.
54+
- Если нужно форматирование, ограничивай его изменёнными файлами и избегай широкого churn в config-файлах.
55+
- Не коммить без явной просьбы пользователя. Для commit или PR загружай `github-workflow`.
56+
57+
## Common Mistakes
58+
59+
- Добавлять README-only документацию для фичи, которой нужна настоящая docs page.
60+
- Забывать VitePress sidebar для новой страницы, которая должна быть в навигации.
61+
- Добавлять version availability в README.
62+
- Документировать shortcuts или поведение без проверки реализации.
63+
- Запускать широкие formatters, которые переписывают существующий стиль docs config.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../.agents/skills/documentation-workflow

AGENTS.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@ massCode — это приложение на Electron + Vue 3 + TypeScript с T
3232
Используй при изменениях, связанных с `code` / `notes` / `math` / `tools`, markdown-space state, sync behavior или `spaces:*` IPC.
3333
- `.agents/skills/i18n/SKILL.md`
3434
Используй для правил локализации, размещения locale keys, `i18n.t(...)` и требования не хардкодить строки.
35+
- `.agents/skills/documentation-workflow/SKILL.md`
36+
Используй для добавления или обновления документации, страниц `docs/website/documentation`, sidebar, assets и README-упоминаний фич.
3537
- `.agents/skills/development-workflow/SKILL.md`
3638
Используй для repo-specific workflow rules: scoped lint/test команды и обязательные follow-up шаги после изменений source-of-truth файлов.
3739
- `.agents/skills/github-workflow/SKILL.md`
@@ -45,6 +47,7 @@ massCode — это приложение на Electron + Vue 3 + TypeScript с T
4547
- Generated types / renderer typing задача: `architecture-standards``api-and-typing`.
4648
- Spaces задача: `architecture-standards``spaces-architecture`.
4749
- Задача про текст и локализацию: `i18n`.
50+
- Задача про документацию или README: `documentation-workflow`.
4851
- Workflow-чувствительная задача: `development-workflow`.
4952
- Задача про git / branch / commit / PR: `github-workflow`.
5053

0 commit comments

Comments
 (0)