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

О документации

Этот сайт объединяет техническую документацию всех проектов компании в едином портале на базе Docusaurus.

Разделы документации​

Документация организована по проектам:

  • Common - общие процессы разработки, стандарты кодирования, инструменты
  • Media - платформа управления медиа-контентом
  • Scount - платформа аналитики и скоринга

Как устроена документация​

Автоматическая синхронизация​

Документация автоматически собирается из репозиториев каждого проекта:

Common/documentation/ → копируется в → docusaurus/docs/common/
Media/documentation/  → копируется в → docusaurus/docs/media/
Scount/documentation/ → копируется в → docusaurus/docs/scount/

Синхронизация происходит автоматически при деплое через CI/CD.

Где редактировать документацию​

⚠️ Важно: Изменения нужно вносить в исходных репозиториях проектов, а не напрямую в репозиторий Docusaurus.

Правильно:

# Редактируйте документацию в репозитории проекта
cd E:\Working\Gitlab\Common\documentation
# Внесите изменения
git add .
git commit -m "Update documentation"
git push

# Затем дождитесь завершения пайплайнов и публикации документации

Неправильно:

# ❌ НЕ редактируйте напрямую в docusaurus/docs/common/
# Эти изменения будут затёрты при следующей синхронизации!

Поиск по документации​

Сайт оснащён локальным поиском, который индексирует все разделы документации.

Как использовать:

  • Нажмите иконку 🔍 в правом верхнем углу
  • Или используйте горячую клавишу Ctrl+K (Windows/Linux) / Cmd+K (macOS)

Особенность: Поиск работает только в продакшн-режиме (npm run build && npm run serve). В dev-режиме (npm start) индекс поиска не создается для ускорения разработки.

Как добавить новую страницу​

  1. Создайте markdown файл в папке documentation/ вашего проекта:
---
sidebar_position: 5
title: Название страницы
---

# Заголовок

Содержимое страницы...

  1. Сохраните и закоммитьте в git проекта

  2. Дождитесь завершения пайплайнов и публикации документации

  3. Изменения появятся на сайте автоматически

Структура навигации​

Навигация в боковом меню определяется:

1. Frontmatter в markdown файлах​

---
sidebar_position: 1  # Порядок в списке
title: Название      # Название в навигации
---

2. Файлы _category_.json в папках​

Для создания категорий (разделов) в навигации:

{
  "label": "Процессы разработки",
  "position": 2,
  "collapsible": true,
  "collapsed": false
}

Полезные ссылки​

Техническая информация​

Поддержка​

Если у вас возникли вопросы или проблемы с документацией:

  1. Проверьте README.md
  2. Создайте issue в GitLab
  3. Обратитесь к команде разработки