docs: рефакторинг документации — workflow, прикладные разделы, генерация RULES.md
- Переработан раздел Workflow: заголовки, описания, порядок разделов - Добавлены новые разделы: Генерация кода (workflow), Настройка VS Code (applied) - Убран суффикс .ui.tsx из документации и примеров - Переработан раздел Структура проекта — только Next.js, без React SPA - Приоритет стилизации перенесён из applied/styles в workflow/styling - Убрано дублирование инструментов генерации — единая точка в applied/templates-generation - Переписан concat-md.js: без внешних зависимостей, мета-якоря для навигации в RULES.md - Удалена зависимость concat-md - Обновлена главная страница: названия разделов, URL на RULES.md - Добавлен AGENTS.md с правилами для агентов
This commit is contained in:
32
AGENTS.md
Normal file
32
AGENTS.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# NextJS Style Guide — правила для агентов
|
||||
|
||||
Это проект документации (VitePress). Агент является основным писателем контента в этом проекте — записывает, оформляет и редактирует материал по указаниям пользователя.
|
||||
|
||||
## Документация
|
||||
|
||||
### Tip-блоки со ссылками
|
||||
При создании или редактировании документации добавлять tip-блоки (`::: tip`)
|
||||
с ссылками на связанные разделы, где можно найти развёрнутое описание
|
||||
процесса, действия или настройки.
|
||||
|
||||
Формат:
|
||||
```
|
||||
::: tip Заголовок блока
|
||||
Описание — [Название раздела](/путь).
|
||||
:::
|
||||
```
|
||||
|
||||
Заголовок обязателен — он должен кратко описывать о чём блок.
|
||||
Описание должно объяснять что найдёт читатель по ссылке.
|
||||
|
||||
### Структура разделов
|
||||
- **Workflow** — порядок действий ("что делать и в каком порядке")
|
||||
- **Базовые правила** — стандарты и конвенции ("каким должен быть код")
|
||||
- **Прикладные разделы** — конфигурация и устройство конкретной области ("как это настроить и использовать")
|
||||
|
||||
Не дублировать информацию между разделами — использовать ссылки.
|
||||
|
||||
### Единообразие
|
||||
- Заголовок страницы (h1) совпадает с названием в sidebar.
|
||||
- Описание раздела (текст после h1) раскрывает смысл через "Как...".
|
||||
- Не описывать инструменты генерации в каждом разделе — ссылаться на прикладной раздел "Шаблоны и генерация кода".
|
||||
Reference in New Issue
Block a user