Документация

Этот сайт собирается из Markdown-файлов в docs/ через обёртку Docusaurus в docs-site/ и публикуется на GitHub Pages.

Локальная сборка

Установите Node.js 20+, затем зависимости Docusaurus:

cd docs-site
npm ci

Соберите сайт:

npm run build

Для локального предпросмотра:

npm run start

По умолчанию Docusaurus откроет сайт на http://127.0.0.1:3000/. Для проверки готового артефакта после сборки:

npm run serve

Что публикуется

Публичный сайт включает:

• пользовательские руководства из docs/*.md;
• заметки по архитектуре из docs/architecture/;
• ссылки на запускаемые примеры и руководства по интеграциям в репозитории;
• ссылки на GitHub на манифесты развёртывания и другие файлы вне docs/.

Правила обновления

• Держите README и docs-site/sidebars.ts согласованными по списку основных документов.
• Для ссылок на файлы вне docs/ используйте URL-адреса GitHub, иначе опубликованный сайт может вести за пределы артефакта Pages.
• Не публикуйте секреты, локальные .env, учётные данные, ключи или необработанные полезные нагрузки трафика.
• При изменении поведения развёртывания обновляйте одновременно docs/deployment.md, deploy/README.md и соответствующие манифесты compose.
• При изменении поведения совместимости обновляйте docs/api-compatibility.md и docs/client-parameter-compatibility.md.