Эта страница задает правила для AI-агентов, которые читают или обновляют Wiki.js документацию Relaxi.
Wiki — это карта знаний по Relaxi, а не зеркало репозиториев. Она должна помогать понять систему целиком: продуктовые домены, архитектурные решения, клиенты, сервисы, эксплуатационные правила и связи между ними.
Не копировать большие документы из репозиториев в wiki без необходимости. Если repo doc является первичным источником, wiki должна кратко объяснить контекст и сослаться на него.
Первичные документы:
relaxi-api/docs/struct.md — архитектура API.relaxi-api/docs/endpoints.md — HTTP-контракты.relaxi-api/docs/availability-engine.md — availability и booking rules.relaxi-api/docs/access-control.md — Logto, Casbin и access model.relaxi-api/docs/dictionary.md — справочники и гео.relaxi-api/docs/notifications.md — notifications, WebSocket, push.relaxi-api/docs/outbox.md — outbox и NATS JetStream.auth/docs/registration-legal-flow.md — registration legal flow.relaxi-workspace/AGENTS.md — Angular workspace shape и frontend rules.relaxi_mobile_public/docs/mobile.md — mobile screens, flows, entities.| Если документ про... | Куда писать |
|---|---|
| Общую карту системы | overview/* |
| Бизнес-процесс или сквозной домен | domains/* |
| Конкретный клиентский интерфейс | clients/* |
| Конкретный сервис или репозиторий | services/* |
| Команды, деплой, тесты, миграции, troubleshooting | engineering/* |
| Архитектурное решение и tradeoffs | decisions/* |
| Legacy/reference материал | legacy/* |
Хорошая страница должна содержать:
Плохая страница:
Organization — бизнес/юридическая сущность.Venue — публичная marketplace-сущность и филиал.Resource — бронируемый или производственный ресурс: зал, мастер, оборудование.Workspace — внутренняя capacity-единица, не публичная сущность.BookingDraft — незавершенный booking flow.Availability — read model доступности; не гарантия создания брони.Legal documents и User consents — source of truth в relaxi-api, не в Logto customData./domains/availability-and-booking.relaxi-api/docs/endpoints.md.AI-агент должен:
AI-агент должен:
Если пользователь просит “изучить”, это значит внимательно изучить контекст: wiki, repo docs, код и связи между ними. Нельзя поверхностно посмотреть одну страницу и делать вид, что вся система понятна.