| 1 | # Сайт документации (GitHub Pages) |
| 2 | |
| 3 | Публичный сайт: **https://ai-guiders.github.io/cascade-ide/** |
| 4 | |
| 5 | **UX-доки** лежат в `docs/ui-ux/` (не `docs/ux/`): папка `ux` совпадала с двухбуквенным кодом языка в mkdocs-static-i18n и не попадала в сборку. На сайте: [Раскладка UI](https://ai-guiders.github.io/cascade-ide/ui-ux/cascade-ide-ui-layout-v1/) (HTML, не `.md`). Старые URL `/ux/...` редиректятся через плагин `redirects`. |
| 6 | |
| 7 | ### Языки (RU / EN) |
| 8 | |
| 9 | | Аудитория | С чего начать | |
| 10 | |-----------|----------------| |
| 11 | | Международная (без русского) | https://ai-guiders.github.io/cascade-ide/en/concept-overview/ | |
| 12 | | Русскоязычная | https://ai-guiders.github.io/cascade-ide/ | |
| 13 | |
| 14 | - **RU:** канон тел ADR и большинство архитектурных заметок. |
| 15 | - **EN:** `docs/en/concept-overview.md`, `docs/en/ui-ux/*`, навигатор ADR, **`## Summary (EN)`** в ключевых ADR (0021, 0080, 0010, 0100, 0119, 0120). |
| 16 | - Не использовать двухбуквенные имена папок под `docs/` кроме `docs/en/` (i18n). |
| 17 | |
| 18 | ## Сборка локально |
| 19 | |
| 20 | ```bash |
| 21 | pip install -r requirements-docs.txt |
| 22 | python tools/gen_adr_pages.py |
| 23 | mkdocs serve |
| 24 | ``` |
| 25 | |
| 26 | Открой http://127.0.0.1:8000/ (RU) и http://127.0.0.1:8000/en/ (EN). |
| 27 | |
| 28 | ## Навигатор ADR |
| 29 | |
| 30 | Скрипт `tools/gen_adr_pages.py` читает `**Статус:**` в шапке каждого `docs/adr/*.md` и генерирует: |
| 31 | |
| 32 | - `docs/site/adr-nav/` — страницы по жизненному циклу (RU) |
| 33 | - `docs/en/site/adr-nav/` — то же (EN) |
| 34 | |
| 35 | Канон статусов: [adr/status-lifecycle.md](adr/status-lifecycle.md). |
| 36 | |
| 37 | Перед коммитом, если менял статус ADR, перезапусти генератор (CI делает это автоматически). |
| 38 | |
| 39 | ## CI |
| 40 | |
| 41 | Workflow `.github/workflows/docs-pages.yml` — push в `develop`/`main` при изменении `docs/`, `mkdocs.yml`, генератора. |
| 42 | |
| 43 | В репозитории GitHub: **Settings → Pages → Source: GitHub Actions**. |
| 44 | |
| 45 | ## Org hub |
| 46 | |
| 47 | Лендинг организации: [ai-guiders.github.io](https://ai-guiders.github.io/) (репозиторий `AI-Guiders.github.io`). |
| 48 | |