Технологии

docs-site это отдельный Hugo-проект с темой LotusDocs.

Ключевые файлы:

  • docs-site/hugo.toml
  • docs-site/content/
  • docs-site/static/
  • docker/docs/Dockerfile

Локальный запуск 

docker compose up docs

Или напрямую:

cd docs-site
hugo server

Сборка production-версии 

cd docs-site
hugo --gc --minify

В production Dockerfile сайт собирается на этапе builder, затем готовый public/ копируется в nginx-образ.

Правила обновления документации

  • документация должна описывать текущее поведение кода, а не планируемое
  • при добавлении нового пользовательского сценария нужно обновлять и раздел API, и раздел сценариев
  • при изменении модели данных или миграций нужно обновлять раздел архитектуры и сопровождения
  • бинарные и чувствительные внутренние материалы не следует публиковать в docs-site/static