sync

README.md

@@ -1,46 +1,13 @@
 # Frontend Style Guide для проектов на React/Next.js и TypeScript
 
-Этот репозиторий содержит документацию с правилами разработки фронтенд-проектов на React/NextJS и TypeScript.
+Это набор правил и практик для разработки фронтенд-проектов: архитектура, типизация, стили, компоненты, API и инфраструктурные разделы.
 
-## Как запустить документацию
+## Как пользоваться
 
-1. Установите зависимости:
-   ```bash
-   npm install
-   ```
-2. Запустите локальный сервер документации:
-   ```bash
-   npm run dev
-   ```
-   Документация будет доступна по адресу http://localhost:5173
+- Начните с «Технологии и библиотеки», чтобы понимать базовые допущения.
+- Затем прочитайте разделы из «Базовых правил».
+- При реализации используйте соответствующие прикладные разделы.
 
-3. Для сборки статики:
-   ```bash
-   npm run build
-   ```
+## Для ассистентов
 
-4. Для предпросмотра собранной документации:
-   ```bash
-   npm run serve
-   ```
-
-## Где находятся документы
-
-- Главная страница документации — `index.md`.
-- Основные разделы — в `parts/` (каждый раздел — отдельный markdown-файл).
-- Конфигурация VitePress — `.vitepress/config.ts`.
-- `README.md` — описание проекта и не связан с `parts/`.
-
-## Генерация RULES.md
-
-- Файл `RULES.md` собирается из содержимого `parts/`.
-- Команда:
-  ```bash
-  npm run docs
-  ```
-
-## Как дополнять документацию
-
-- Добавляйте новые разделы в папку `parts/`.
-- Обновляйте sidebar в `.vitepress/config.ts` для навигации.
-- Используйте только русский язык.
+Полная документация в одном MD файле: https://gromlab.ru/docs/frontend-style-guide/raw/branch/main/RULES.md