📚 Расширенная документация Coreness
Продвинутые руководства для глубокого понимания платформы, разработки плагинов и управления инфраструктурой.
📖 Основная документация: Руководства по сценариям и конфигурации — для создания ботов и работы с платформой
⚡ Оглавление документации
🏗️ Архитектура платформы
- Требования к системе
- Используемые библиотеки
- Операционная база данных
- Структура проекта
- Плагинная архитектура
- Lifecycle приложения
🚀 Развертывание и деплой
🔌 Разработка плагинов
⚙️ Конфигурация плагинов
🎯 Системные действия
⚙️ Настройка системы
📝 Логирование
🧪 Тестирование
📖 Полный индекс документации
🏗️ Архитектура платформы
Что это: Детальное описание архитектуры платформы, паттернов и принципов работы.
Зачем нужно: Понимание внутреннего устройства платформы: от структуры проекта до принципов работы плагинной системы и обработки событий.
Что внутри:
- Event-Driven Architecture — событийная модель
- Vertical Slice Architecture — изоляция компонентов
- Dependency Injection — управление зависимостями
- Multi-tenant архитектура — изоляция данных
- Плагинная система (утилиты и сервисы)
- Lifecycle приложения и graceful shutdown
Когда использовать: Для понимания принципов работы платформы, разработки плагинов, расширения функционала или участия в разработке.
🚀 Развертывание и деплой
Что это: Полное руководство по установке и обновлению платформы.
Зачем нужно: От первоначальной установки до автоматизации деплоя через GitHub Actions и управления версиями.
Что внутри:
- Установка на сервер (Linux, Docker)
- Настройка окружения (test + prod)
- Настройка PostgreSQL и pgvector
- Миграции базы данных
- Автоматический деплой через GitHub Actions
- Система обновлений и откатов
- Backup и восстановление
- Мониторинг и логирование
Когда использовать: При развертывании платформы в production окружении, настройке CI/CD или обновлении версий.
🔌 Разработка плагинов
Что это: Руководство по созданию собственных сервисов и утилит.
Зачем нужно: Расширяйте функционал платформы через плагинную архитектуру: создавайте сервисы для обработки событий или утилиты для вспомогательных задач.
Что внутри:
- Типы плагинов (сервисы и утилиты)
- Структура плагина и config.yaml
- Lifecycle методы (initialize, startup, shutdown)
- Dependency Injection в плагинах
- Примеры создания плагинов
- Best practices и рекомендации
Когда использовать: При необходимости добавить новый функционал, интегрировать внешние сервисы или создать собственные действия для сценариев.
⚙️ Конфигурация плагинов
Что это: Детальное описание структуры config.yaml для плагинов.
Зачем нужно: Полный справочник по всем возможным параметрам конфигурации плагинов и их назначению.
Что внутри:
- Структура config.yaml
- Обязательные и опциональные поля
- Описание интерфейсов (services, actions, events)
- Dependency Injection в конфигурации
- Примеры для разных типов плагинов
Когда использовать: При разработке плагинов для правильной настройки config.yaml.
🎯 Системные действия
Что это: Полный справочник внутренних действий платформы.
Зачем нужно: Детальное описание всех системных действий, используемых в сценариях: от отправки сообщений до работы с базой данных.
Что внутри:
- Все действия с описанием параметров
- Входные и выходные данные
- Коды ошибок и их обработка
- Примеры использования
- Технические детали реализации
Когда использовать: Для глубокого понимания работы действий или при разработке собственных действий для плагинов.
⚙️ Настройка системы
Что это: Глобальные параметры платформы.
Зачем нужно: Конфигурация общесистемных параметров через config/settings.yaml: управление плагинами, пути к файлам, настройки shutdown и другие глобальные параметры.
Что внутри:
- Управление плагинами (включение/отключение)
- Глобальные настройки (пути, лимиты)
- Graceful shutdown параметры
- Настройки сервисов
- Примеры конфигураций
Когда использовать: При настройке окружения, оптимизации производительности или управлении включенными плагинами.
📝 Логирование
Что это: Работа с логами и отладкой.
Зачем нужно: Настройка системы логирования, уровни логов, структура логов и рекомендации по отладке приложения.
Что внутри:
- Уровни логирования (DEBUG, INFO, WARNING, ERROR)
- Структура логов и форматирование
- Настройка логирования для плагинов
- Просмотр логов в Docker
- Отладка и troubleshooting
- Best practices
Когда использовать: При отладке проблем, мониторинге работы платформы или разработке плагинов.
🧪 Тестирование
Что это: Подходы к тестированию платформы.
Зачем нужно: Стратегии тестирования сценариев, плагинов и всей платформы в целом.
Что внутри:
- Тестирование сценариев
- Unit тесты для плагинов
- Интеграционное тестирование
- E2E тестирование ботов
- Тестовое окружение
- Примеры тестов
Когда использовать: При разработке сценариев, создании плагинов или настройке CI/CD.
🎯 Рекомендуемый порядок изучения
Для разработчиков платформы:
- Архитектура — поймите устройство платформы
- Разработка плагинов — научитесь создавать плагины
- Конфигурация плагинов — изучите config.yaml
- Системные действия — углубитесь в действия
- Логирование — настройте отладку
- Тестирование — организуйте тестирование
Для администраторов платформы:
- Развертывание — разверните платформу
- Настройка системы — оптимизируйте конфигурацию