Stack Docs
Документація проєкту. Корінь — глобальні речі (конвенції, глосарій, ролі). Сервіси — кожен у своєму репо, агрегуються сюди автоматично.
Робочий процес доки — 3 правила (дуже важливо, знати й пам'ятати завжди)
- Маленькими порціями, одразу — оновив, комить у
docs, не накопичуй.docs= публікаційна гілка — працюй будь-де → мердж уdocs→ пуш (сайт збирається зdocs).- Змінив код — відпишись про доку: «оновив
docs/X» або «доки нема». Не мовчи.Деталі — у AUTHORING.
Початок
- Як це працює → README
- Правила формату → CONVENTIONS
- Як створювати/оновлювати сторінки → AUTHORING
- Глосарій термінів → glossary
- Каталог ролей → roles
- Приклади Mermaid-діаграм → diagram-examples (стенд із усіма типами що рендеряться)
- Приклади оформлення → formatting-examples (іменовані патерни таблиць, callout-ів, індексів — «оформи в стилі Назва»)
Архітектура
- Огляд сервісів → Architecture
- Карта Swagger-ів і конвенція API → API Map
- План для нового Family-беку → Family Blueprint
- Як працює пайплайн доки → Docs Pipeline
Сервіси
Кожен сервіс має свою документацію в services/<name>/.
| № | Сервіс | Призначення | Статус |
|---|---|---|---|
| 1 | stack-client | Фронтенд | в роботі |
| 2 | stack | Оркестратор + auth | каркас #draft |
| 3 | stack-academy | Внутрішня школа | готово |
| 4 | stack-udate | Бек udate | каркас #draft |
| 5 | stack-golden | Бек goldenbride | в роботі |
| 6 | stack-electron | Електрон | в роботі |
| 7 | stack-prime | Бек prime | каркас #draft |
| 8 | stack-chathouse | Бек chathouse | каркас #draft |
| 9 | stack-ai | AI-сервіс | заплановано |