Онбординг

Это минимальный маршрут для разработчика, который начинает работать с CRM RMS и должен быстро понять код, API и документацию.

---

Быстрый маршрут

1. Прочитайте Обзор системы, чтобы понять доменные контуры.
2. Откройте Основные сущности, чтобы увидеть реальные связи данных.
3. Пройдите Жизненный цикл проекта, потому что проект связывает почти все модули.
4. Изучите Security & RBAC, прежде чем менять доступы.
5. Для конкретного API откройте Scalar API Reference.

---

Где смотреть код

Задача	Где искать
HTTP route и DTO	internal/modules/<module>/transport_http.go
Бизнес-правила	internal/modules/<module>/service.go
SQL	internal/modules/<module>/repository_pg.go
Enum и модель	model.go, status.go
Регистрация модуля	internal/app/app.go
OpenAPI metadata	internal/contractspec/*
Миграции	migrations/*.sql

---

Правило документации

Существенная задача не считается завершенной без обновления документации.

Существенные изменения:

• API routes, DTO, validation;
• permissions, RBAC, проектные секции;
• БД и миграции;
• бизнес-статусы и workflow;
• background jobs и operational setup;
• frontend workflow или contract shape.

Для концептуального поведения обновляйте VitePress markdown под docs/. Для API-изменений регенерируйте артефакты:

go run ./cmd/generate_contracts
go run ./cmd/generate_endpoints

---

Как писать концепции

Ориентир по стилю — Логистический контур.

Страница должна:

1. Объяснить процесс простыми словами.
2. Назвать реальные backend-модули и endpoint-группы.
3. Перечислить актуальные статусы и важные переходы.
4. Отдельно сказать, что должен делать frontend.
5. Ссылаться на Scalar для полной схемы API, а не копировать весь OpenAPI вручную.

Не используйте статусы, поля и endpoint-ы без проверки в коде.