Документация для разработчиков
Здесь — карта модулей OKS: где лежит код модуля на клиенте и на сервере, какие таблицы он
использует, какие у него точки входа и неочевидные решения. Общие правила архитектуры
(FSD на клиенте, routes → controller → service → model на сервере, лимит 200 строк на файл)
описаны в CLAUDE.md в корне репозитория — здесь их не повторяем.
Раздел лежит в docs/dev/, коммитится в git и публикуется отдельным сайтом dev.oks-oasis.kz
(npm run start:dev — локально, npm run build:dev — сборка в build-dev/).
Пользовательская документация — отдельно, в docs/docs/ (/user).
Шаблон страницы модуля
Одна страница на модуль: docs/dev/modules/<module>.md. Разделы:
- Коротко — что делает модуль, право доступа, URL страницы, ключевые сущности.
- Карта файлов — дерево клиента (pages / widgets / features / entities) и сервера (routes / controllers / services / model), по строке на файл или папку.
- Точки входа извне — где модуль подключён в чужом коде (роутер, шапка, настройки, cron).
- Данные — свои таблицы и чужие таблицы, которые модуль трогает (и через какой файл).
- API — список эндпоинтов и права.
- Ключевые потоки — 2–5 главных сценариев: кто кого вызывает.
- Ловушки и решения — то, что не видно из кода с первого взгляда.
- Тесты — где лежат и как запускать.
Страницу обновляем в той же задаче, в которой меняется структура модуля.