# Repository Guidelines ## Назначение репозитория Этот репозиторий хранит документацию и правила разработки фронтенд‑проектов (React/Next.js, TypeScript) и публикуется через VitePress. Контент пишется на русском языке. Сейчас ведётся рефакторинг документации: цель — краткие, чёткие и не дублирующиеся правила. ## Project Structure & Module Organization - `index.md` — главная страница документации. - `parts/` — разделы документации, один файл на тему. Именование: `N-title.md` в `kebab-case` (например, `3-code-style.md`). - `.vitepress/config.ts` — конфигурация VitePress и sidebar; добавляя новый раздел, обновляйте список ссылок. - `RULES.md` — агрегированный документ, собирается из `parts/`. - `concat-md.js` — скрипт сборки `RULES.md`. - `OLD_parts/` — архив старой документации, используется только как справочник при переносе идей. ## Build, Test, and Development Commands - `npm install` — установка зависимостей. - `npm run dev` — локальный сервер VitePress (обычно localhost:5173). - `npm run build` — сборка статического сайта. - `npm run serve` — предпросмотр собранной статики. - `npm run docs` — пересборка `RULES.md` из `parts/`. ## Coding Style & Naming Conventions - Язык документации — русский. - Для новых разделов придерживайтесь нумерации и `kebab-case` в именах файлов. - В примерах кода ориентируйтесь на правила из `RULES.md`: отступ 2 пробела, одинарные кавычки в TS, двойные в JSX, `import type` для типов, избегать `default` экспортов. ## Принципы рефакторинга документации - Один смысл — один раздел. Не размазывайте правила по нескольким файлам. - Если правило уже описано (например, нейминг), не повторяйте его в других разделах — добавляйте недостающее только в профильный файл. - При переносе из `OLD_parts/` переписывайте кратко и по делу, исключая устаревшее и дубли. - Новые правила добавляйте только в подходящий раздел; если такого нет — создайте его и обновите sidebar. ## Testing Guidelines Тестовая инфраструктура отсутствует. Если добавляете тесты или проверяющие скрипты, добавьте соответствующий `npm`‑скрипт и опишите его в этом документе. ## Commit & Pull Request Guidelines - История коммитов содержит короткие однословные сообщения (например, `sync`, `first`) — формального стандарта не видно. - Для PR: укажите цель изменений, список затронутых разделов и отметьте, обновляли ли `RULES.md` и `sidebar`. - Если меняется структура документации или навигация, приложите краткий скриншот/описание результата.