add docs
All checks were successful
SonarQube / Build and analyze (push) Successful in 3m22s

This commit is contained in:
Leonid Pershin
2025-10-21 05:08:40 +03:00
parent bc1b3c4015
commit e5e69470f8
12 changed files with 3550 additions and 6 deletions

63
docs/README.md Normal file
View File

@@ -0,0 +1,63 @@
# 📚 Документация ChatBot
Добро пожаловать в документацию проекта **ChatBot** — интеллектуального Telegram-бота на базе AI (Ollama), написанного на .NET 9.
## 📖 Содержание
### 🎯 Основное
- [Обзор проекта](./overview.md) - Общая информация о проекте
- [Быстрый старт](./quickstart.md) - Запуск проекта за 5 минут
- [Установка и настройка](./installation.md) - Подробная инструкция по установке
- [Конфигурация](./configuration.md) - Настройка параметров бота
### 🏗️ Архитектура
- [Архитектура проекта](./architecture/overview.md) - Общая архитектура
- [Слои приложения](./architecture/layers.md) - Описание слоёв
- [Модели данных](./architecture/data-models.md) - Структура данных
- [Базы данных](./architecture/database.md) - Работа с PostgreSQL
### 💻 Разработка
- [Структура проекта](./development/project-structure.md) - Организация кода
- [Сервисы](./development/services.md) - Описание всех сервисов
- [Telegram интеграция](./development/telegram-integration.md) - Работа с Telegram Bot API
- [AI сервисы](./development/ai-services.md) - Интеграция с Ollama
- [Dependency Injection](./development/dependency-injection.md) - Управление зависимостями
### 📝 API и интерфейсы
- [Команды бота](./api/bot-commands.md) - Все доступные команды
- [Интерфейсы сервисов](./api/service-interfaces.md) - Описание интерфейсов
- [Health Checks](./api/health-checks.md) - Мониторинг здоровья
### 🧪 Тестирование
- [Стратегия тестирования](./testing/strategy.md) - Подход к тестированию
- [Unit тесты](./testing/unit-tests.md) - Модульное тестирование
- [Integration тесты](./testing/integration-tests.md) - Интеграционное тестирование
- [Покрытие кода](./testing/coverage.md) - Code coverage
### 🚀 Развертывание
- [Docker развертывание](./deployment/docker.md) - Запуск в Docker
- [CI/CD](./deployment/ci-cd.md) - Автоматизация сборки
- [Мониторинг](./deployment/monitoring.md) - Логирование и мониторинг
### 🔧 Дополнительно
- [FAQ](./faq.md) - Часто задаваемые вопросы
- [Troubleshooting](./troubleshooting.md) - Решение проблем
- [Contributing](./contributing.md) - Как внести вклад
- [Changelog](./changelog.md) - История изменений
## 🔗 Быстрые ссылки
- [GitHub Repository](https://gitea.hsrv.site/mrleo1nid/ChatBot)
- [Issues](https://gitea.hsrv.site/mrleo1nid/ChatBot/issues)
- [Releases](https://gitea.hsrv.site/mrleo1nid/ChatBot/releases)
## 📞 Поддержка
Если у вас возникли вопросы или проблемы:
1. Проверьте [FAQ](./faq.md)
2. Изучите [Troubleshooting](./troubleshooting.md)
3. Создайте [Issue](https://gitea.hsrv.site/mrleo1nid/ChatBot/issues)
## 📄 Лицензия
Проект распространяется под лицензией MIT. См. [LICENSE.txt](../LICENSE.txt) для подробностей.