3.6 KiB
3.6 KiB
📚 Документация ChatBot
Добро пожаловать в документацию проекта ChatBot — интеллектуального Telegram-бота на базе AI (Ollama), написанного на .NET 9.
📖 Содержание
🎯 Основное
- Обзор проекта - Общая информация о проекте
- Быстрый старт - Запуск проекта за 5 минут
- Установка и настройка - Подробная инструкция по установке
- Конфигурация - Настройка параметров бота
🏗️ Архитектура
- Архитектура проекта - Общая архитектура
- Слои приложения - Описание слоёв
- Модели данных - Структура данных
- Базы данных - Работа с PostgreSQL
💻 Разработка
- Структура проекта - Организация кода
- Сервисы - Описание всех сервисов
- Telegram интеграция - Работа с Telegram Bot API
- AI сервисы - Интеграция с Ollama
- Dependency Injection - Управление зависимостями
📝 API и интерфейсы
- Команды бота - Все доступные команды
- Интерфейсы сервисов - Описание интерфейсов
- Health Checks - Мониторинг здоровья
🧪 Тестирование
- Стратегия тестирования - Подход к тестированию
- Unit тесты - Модульное тестирование
- Integration тесты - Интеграционное тестирование
- Покрытие кода - Code coverage
🚀 Развертывание
- Docker развертывание - Запуск в Docker
- CI/CD - Автоматизация сборки
- Мониторинг - Логирование и мониторинг
🔧 Дополнительно
- FAQ - Часто задаваемые вопросы
- Troubleshooting - Решение проблем
- Contributing - Как внести вклад
- Changelog - История изменений
🔗 Быстрые ссылки
📞 Поддержка
Если у вас возникли вопросы или проблемы:
- Проверьте FAQ
- Изучите Troubleshooting
- Создайте Issue
📄 Лицензия
Проект распространяется под лицензией MIT. См. LICENSE.txt для подробностей.