docs/nextjs-style-guide
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: добавлен CONTRIBUTING.md, удалён AGENTS.md

Browse Source 
- создан CONTRIBUTING.md с мета-правилами работы над документацией
- описаны три типа документации (workflow, базовые, прикладные) и границы между ними
- добавлен шаблон структуры прикладного раздела
- зафиксированы конвенции оформления (frontmatter, заголовки, примеры, таблицы)
- удалён устаревший AGENTS.md
This commit is contained in:
Сергей Громов
2026-03-30 09:10:21 +03:00
parent bc01cb930a
commit 43f2d92201
2 changed files with 220 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
AGENTS.md
View File

@@ -1,32 +0,0 @@
# NextJS Style Guide — правила для агентов
Это проект документации (VitePress). Агент является основным писателем контента в этом проекте — записывает, оформляет и редактирует материал по указаниям пользователя.
## Документация
### Tip-блоки со ссылками
При создании или редактировании документации добавлять tip-блоки (`::: tip`)
с ссылками на связанные разделы, где можно найти развёрнутое описание
процесса, действия или настройки.
Формат:
```
::: tip Заголовок блока
Описание — [Название раздела](/путь).
:::
```
Заголовок обязателен — он должен кратко описывать о чём блок.
Описание должно объяснять что найдёт читатель по ссылке.
### Структура разделов
- **Workflow** — порядок действий ("что делать и в каком порядке")
- **Базовые правила** — стандарты и конвенции ("каким должен быть код")
- **Прикладные разделы** — конфигурация и устройство конкретной области ("как это настроить и использовать")
Не дублировать информацию между разделами — использовать ссылки.
### Единообразие
- Заголовок страницы (h1) совпадает с названием в sidebar.
- Описание раздела (текст после h1) раскрывает смысл через "Как...".
- Не описывать инструменты генерации в каждом разделе — ссылаться на прикладной раздел "Шаблоны и генерация кода".