Stack Docs

Документація проєкту. Корінь — глобальні речі (конвенції, глосарій, ролі). Сервіси — кожен у своєму репо, агрегуються сюди автоматично.

Робочий процес доки — 3 правила (дуже важливо, знати й пам'ятати завжди)

  1. Маленькими порціями, одразу — оновив доку - коміть та пуш docs, не накопичуй.
  2. docs = публікаційна гілка — працюй будь-де → мердж у docs → пуш (сайт збирається з docs).
  3. Змінив код — відпишись про доку: «оновив docs/X» або «доки нема». Не ігноруй!

Деталі — у AUTHORING.

Початок

  • Як це працює → README
  • Правила формату → CONVENTIONS
  • Як створювати/оновлювати сторінки → AUTHORING
  • Глосарій термінів і ролей → glossary
  • Приклади Mermaid-діаграм → diagram-examples (стенд із усіма типами що рендеряться)
  • Приклади оформлення → formatting-examples (іменовані патерни таблиць, callout-ів, індексів — «оформи в стилі Назва»)

Архітектура

  • Огляд сервісів → Architecture
  • Карта Swagger-ів і конвенція API → API Map
  • Цільова платформа проєктів → Project Platform
  • Як працює пайплайн доки → Docs Pipeline

Сервіси

Кожен сервіс має свою документацію в services/<name>/.

№СервісПризначенняСтатус
1stack-clientФронтендв роботі
2stackОркестратор + authкаркас #draft
3stack-academyВнутрішня школаготово
4stack-udateБек udateкаркас #draft
5stack-goldenБек goldenbrideв роботі
6stack-electronЕлектронв роботі
7stack-primeБек primeкаркас #draft
8stack-chathouseБек chathouseкаркас #draft
9stack-aiAI-сервісзаплановано
10project-application-apiProject Platform: спільне API frontend та Electron, canonical collectionsв роботі

Крос-сервісне