0007 — Репозитории и документация¶
- Дата: 2026-08-21.
- Статус: Принято; выбор VitePress заменён Material for MkDocs решением 0015, test-домены документации уточнены решением 0019.
- Ответственный: владелец проекта.
Контекст¶
Product-код, публичный лендинг, пользовательская документация и внутреннее руководство разработчика имеют разные циклы публикации и разные требования к доступу. Их объединение в одном репозитории создало бы лишние зависимости релизов и доступов.
Решение¶
Экосистема использует три приватных репозитория:
webuzateam/SkuAro-DEV— product-монорепозиторий.webuzateam/SkuAro-Site— публичный лендинг.webuzateam/SkuAro-Docs— пользовательская и разработческая документация.
Product-репозиторий хранит ADR, domain/contracts, миграции, инфраструктуру, security/runbook, release metadata и status. Docs-репозиторий планируется как VitePress workspace с apps/user-docs, apps/dev-docs, packages/docs-theme. Site-репозиторий содержит только публичный сайт и публичные legal/contact материалы.
OpenAPI создаётся из контрактов product-репозитория и передаётся в developer docs как сгенерированный артефакт. Пользовательские инструкции и release notes обновляются вместе с затрагивающим их production-релизом. Подробный процесс закреплён в docs/DOCUMENTATION_STRATEGY.md.
Причины¶
Разделение делает доступы и deploy независимыми, не нагружает product-репозиторий содержимым двух сайтов и сохраняет единый источник истины для технических контрактов.
Последствия¶
- Прежнее правило «один приватный репозиторий на весь проект» заменяется правилом «один приватный репозиторий на отдельный поставляемый контур».
- Site и Docs репозитории пока только согласованы; их создание является внешним действием и требует отдельного разрешения.
doc-dev.skuaro.topзащищён и не индексируется;doc.skuaro.comпубличен.- Внутренние server paths, credentials и секреты не публикуются в user docs.
Откат или замена¶
Объединение или дополнительное разделение репозиториев требует нового решения и плана переноса истории, deploy и источников истины.