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

Добро пожаловать в документацию проекта CatLink! Здесь вы найдете всю необходимую информацию для работы с проектом.

## 📖 Документы

### 🛠️ Для разработчиков

- **[MAKEFILE.md](./MAKEFILE.md)** - Полное руководство по командам Make для разработки и деплоя
- **[CICD.md](./CICD.md)** - Документация по CI/CD пайплайну и автоматизации
- **[DOCKER_OPTIMIZATION.md](./DOCKER_OPTIMIZATION.md)** - Оптимизация Docker образов и .dockerignore
- **[DEPLOYMENT.md](./DEPLOYMENT.md)** - Инструкции по развертыванию в продакшене
- **[FIXES.md](./FIXES.md)** - Известные проблемы и их решения
- **[TELEGRAM_SETUP.md](./TELEGRAM_SETUP.md)** - Настройка Telegram уведомлений для CI/CD

### 🧪 Для тестировщиков

- **[COVER_OVERLAY_TESTING.md](./COVER_OVERLAY_TESTING.md)** - Документация по тестированию покрытия

## 🚀 Быстрые ссылки

### Для начинающих
1. Начните с [README.md](../README.md) в корне проекта
2. Изучите [MAKEFILE.md](./MAKEFILE.md) для понимания команд
3. Ознакомьтесь с [CICD.md](./CICD.md) для понимания автоматизации
4. Следуйте инструкциям в [DEPLOYMENT.md](./DEPLOYMENT.md) для деплоя

### Для опытных разработчиков
- Используйте `make help` для просмотра всех команд
- Изучите [CICD.md](./CICD.md) для настройки автоматизации
- Проверьте [FIXES.md](./FIXES.md) при возникновении проблем
- Следуйте документации в [DEPLOYMENT.md](./DEPLOYMENT.md) для продакшена

## 🔧 Структура документации

```
docs/
├── README.md                    # Этот файл - обзор документации
├── MAKEFILE.md                  # Руководство по командам Make
├── CICD.md                      # Документация по CI/CD и автоматизации
├── DOCKER_OPTIMIZATION.md       # Оптимизация Docker образов
├── DEPLOYMENT.md                # Инструкции по деплою
├── FIXES.md                     # Исправления и решения проблем
├── TELEGRAM_SETUP.md            # Настройка Telegram уведомлений
└── COVER_OVERLAY_TESTING.md     # Документация по тестированию
```

## 📋 Краткий справочник команд

### Основные команды Make
```bash
make help              # Показать все команды
make install           # Первая установка
make dev-bg           # Запуск для разработки
make status           # Проверить статус
make health           # Проверить работоспособность
```

### Управление данными
```bash
make migrate-full     # Миграции и сбор статики
make backup           # Создать бэкап БД
make restore          # Восстановить БД
```

### Docker и оптимизация
```bash
make build-optimized  # Сборка оптимизированных образов
make analyze-images   # Анализ размеров образов
make clean-unoptimized # Очистка неоптимизированных образов
```

### CI/CD и автоматизация
```bash
make ci-lint          # Проверка кода (CI)
make ci-test          # Запуск тестов (CI)
make ci-security      # Проверка безопасности
make ci-pipeline      # Полный CI/CD пайплайн
make drone-validate   # Валидация Drone конфигурации
```

### Деплой
```bash
make deploy           # Деплой в продакшен
make ssl-setup        # Настройка SSL
make ci-deploy-staging     # Деплой на staging
make ci-deploy-production  # Деплой на production
```

Подробнее см. [MAKEFILE.md](./MAKEFILE.md)

## 🆘 Получить помощь

1. **Проверьте документацию** - Возможно, ответ уже есть в одном из документов
2. **Поищите в Issues** - [GitHub Issues](https://github.com/smartsoltech/links/issues)
3. **Создайте новый Issue** - Если проблема не найдена

## 🤝 Вклад в документацию

Помогите улучшить документацию:

1. Форкните репозиторий
2. Улучшите или добавьте документацию
3. Создайте Pull Request

### Рекомендации по написанию документации:
- Используйте ясный и понятный язык
- Добавляйте примеры кода
- Включайте скриншоты когда это помогает
- Обновляйте документацию при изменении функционала

---

📖 **[Вернуться к главному README](../README.md)**