20 lines
1.6 KiB
Markdown
20 lines
1.6 KiB
Markdown
|
# Правила для агентов
|
|||
|
|
|
|||
|
|
При работе с документацией следовать правилам из CONTRIBUTING.md.
|
|||
|
|
|
|||
|
|
- Язык документации и коммитов — русский.
|
|||
|
|
- После изменений в `.md`-файлах — запустить `npm run docs` для обновления RULES.md.
|
|||
|
|
- При добавлении нового раздела — обновить сайдбар (`.vitepress/config.ts`)
|
|||
|
|
и порядок файлов (`concat-md.js`).
|
|||
|
|
|
|||
|
|
## Структура страницы документации
|
|||
|
|
|
|||
|
|
Каждая страница начинается одинаково:
|
|||
|
|
|
|||
|
|
1. **Заголовок** (`h1`) — совпадает с `title` из frontmatter.
|
|||
|
|
2. **Описание раздела** — 1–2 строки сразу после заголовка. Говорит, что это за раздел, какую информацию он описывает и что читатель в нём получит. Не про предмет раздела, а про сам раздел.
|
|||
|
|
3. **Определение** (`## Определение`) — для справочных страниц, посвящённых одному термину. Короткая формулировка жирным: что это за сущность и какую роль она играет. Идёт первым `h2` после описания раздела.
|
|||
|
|
4. **Контент** — остальные `h2`-подразделы.
|
|||
|
|
|
|||
|
|
Правило применяется ко всем разделам документации без исключений.
|