42 lines
2.0 KiB
Markdown
42 lines
2.0 KiB
Markdown
# Документация EUSRR
|
||
|
||
Начальная точка для разработчика — основной [`README.md`](../README.md). Нормативные технические руководства находятся в [`guides/`](guides/).
|
||
|
||
## Актуальные источники
|
||
|
||
- [HTTP API](guides/API.md)
|
||
- [LDAP и Active Directory](guides/LDAP.md)
|
||
- [WebSocket и realtime](guides/WEBSOCKET.md)
|
||
- [Уведомления](guides/NOTIFICATIONS.md)
|
||
- [Frontend UI system](guides/frontend/)
|
||
- [Scheduling module](../backend/scheduling/README.md)
|
||
- [Procurement module](../backend/procurement/README.md)
|
||
- [Finance module](../backend/finance/README.md)
|
||
- [Аналитика компании](guides/COMPANY_ANALYTICS.md)
|
||
- [Payroll core](../backend/payroll_core/README.md)
|
||
|
||
Интерактивные runtime-контракты:
|
||
|
||
- `/api/docs/` — Swagger UI;
|
||
- `/api/redoc/` — ReDoc;
|
||
- `/api/schema/` — OpenAPI schema;
|
||
- `/api/ws/docs/` — WebSocket documentation;
|
||
- `/api/ws/schema/` — AsyncAPI schema.
|
||
|
||
## Каталоги
|
||
|
||
- `guides/` — поддерживаемые инструкции и контракты;
|
||
- `guides/frontend/` — frontend UI foundations, patterns и review workflow.
|
||
|
||
Операционные темы: [Celery](guides/CELERY.md),
|
||
[caching](guides/CACHING_SETUP.md), [CORS](guides/DJANGO_CORS_SETUP.md),
|
||
[object permissions](guides/DJANGO_RULES_INTEGRATION.md) и
|
||
[logging](../backend/docs/guides/LOGGING_GUIDE.md).
|
||
|
||
Troubleshooting должен находиться в соответствующем guide, а не в отдельном
|
||
session report.
|
||
|
||
При добавлении документа сначала проверьте, нельзя ли обновить существующий guide или README модуля. Отдельные `*_PLAN.md`, `*_PROGRESS.md`, `*_COMPLETE.md` и session reports в репозитории не создаются.
|
||
|
||
Локальные проекты, внешние привязки и ежедневное участие: [Projects](../backend/projects/README.md).
|