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