36 lines
2.3 KiB
Markdown
36 lines
2.3 KiB
Markdown
# Руководства разработчика
|
||
|
||
В этом каталоге находятся нормативные документы, которые должны соответствовать текущему коду. Планы, отчёты о выполнении и журналы отдельных рефакторингов не являются guides.
|
||
|
||
## Основные контракты
|
||
|
||
- [API.md](API.md) — HTTP API, JWT/auth sessions, OpenAPI, frontend proxy и тестирование.
|
||
- [LDAP.md](LDAP.md) — LDAP/AD authentication, write-back, sync, retry queue и admin.
|
||
- [OIDC.md](OIDC.md) — корпоративный OpenID Connect Provider и подключение Gitea.
|
||
- [WEBSOCKET.md](WEBSOCKET.md) — единый `/ws/`, JWT, actions, events и production proxy.
|
||
- [NOTIFICATIONS.md](NOTIFICATIONS.md) — создание, доставка, REST, realtime, email и Web Push.
|
||
- [COMMERCE.md](COMMERCE.md) — каталог, МойСклад, изображения, Celery и realtime-прогресс.
|
||
|
||
## Frontend
|
||
|
||
- [frontend/](frontend/) — нормативная карта UI-системы, геометрии и workflow review.
|
||
|
||
## Backend и эксплуатация
|
||
|
||
- [CACHING_SETUP.md](CACHING_SETUP.md)
|
||
- [CELERY.md](CELERY.md)
|
||
- [DJANGO_CORS_SETUP.md](DJANGO_CORS_SETUP.md)
|
||
- [DJANGO_RULES_INTEGRATION.md](DJANGO_RULES_INTEGRATION.md)
|
||
- [IP_REGISTRATION_RESTRICTIONS.md](IP_REGISTRATION_RESTRICTIONS.md)
|
||
- [LIVE_VALIDATION_GUIDE.md](LIVE_VALIDATION_GUIDE.md)
|
||
- [REQUESTS_DETAIL_VIEW_GUIDE.md](REQUESTS_DETAIL_VIEW_GUIDE.md)
|
||
- [testing-request-filters.md](testing-request-filters.md)
|
||
|
||
## Правила поддержки
|
||
|
||
1. Guide описывает устойчивый контракт или операционную процедуру, а не историю реализации.
|
||
2. Endpoint-ы REST не перечисляются вручную, если они уже представлены в OpenAPI.
|
||
3. WebSocket message schema меняется вместе с AsyncAPI и tests.
|
||
4. Ссылка на файл должна быть относительной и проходить link check.
|
||
5. Завершённый plan/report удаляется; существенное архитектурное решение переносится в актуальный guide.
|