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

ADR-0005: Публичная документация и портал разработчика

  • Status: accepted
  • Date: 2026-08-26

Решение

Использовать Docusaurus и Mermaid для публичного версионируемого open-source сайта документации, развёртываемого через GitHub Pages. Хранить документацию в Markdown рядом с архитектурой и контрактами.

Каждый репозиторий владеет корневым catalog-info.yaml, mkdocs.yml и каталогом docs. Эти файлы готовы для Backstage Catalog и TechDocs. Backstage — представление для поиска, а не источник истины; авторитетными остаются Git-репозитории. Публичный сайт общей архитектуры продолжает собираться Docusaurus.

Последствия

Внешние участники сразу получают лёгкий публичный портал. Позже команда сможет добавить внутренний каталог сервисов и golden-path scaffolder без миграции модели документации.