Перейти к основному содержимому

Ghost Kitchen — документация

Единое место с документацией проекта Ghost Kitchen: архитектура, бэкенд, фронтенд и общий глоссарий терминов.

Для кого эта документация

  • Команда разработки — фронтенд и бэкенд держат здесь единое описание системы и договорённости.
  • Claude Code — читает эти файлы прямо в репозитории как источник правды (см. CLAUDE.md).
  • Агентство и заказчик — заходят на опубликованный сайт, переключают язык (🌐 RU / EN в шапке) и смотрят актуальное состояние.

Как устроена документация

РазделО чём
ГлоссарийЕдиная терминология RU/EN с всплывающими подсказками
АрхитектураОбщая картина, роли и панели, поток заказа, запуск бренда
БэкендAPI, модель данных, интеграции — зона напарника
ФронтендUI, состояние, дизайн-система — зона фронтендера

Принципы

  1. Один источник правды. Документация живёт в Markdown в репозитории и собирается в сайт автоматически.
  2. Двуязычность. Русский — основной язык; английский — перевод в папке i18n/en.
  3. Терминология — централизованно. Все термины определяются один раз в src/data/glossary.json.