112 lines
4.3 KiB
Markdown
112 lines
4.3 KiB
Markdown
# 📚 Documentation Index / Индекс документации
|
||
|
||
## 🇷🇺 Русская документация / Russian Documentation
|
||
|
||
### Основные руководства / Main Guides
|
||
- **[README.md](README.md)** - Полное руководство (1,420+ строк)
|
||
- **[TESTING_GUIDE.md](TESTING_GUIDE.md)** - Руководство по тестированию
|
||
- **[GITEA_SYNC.md](GITEA_SYNC.md)** - Синхронизация Gitea → GitHub
|
||
- **[PROJECT_STRUCTURE.md](PROJECT_STRUCTURE.md)** - Структура проекта
|
||
|
||
### Справочная информация / Reference
|
||
- **[CHEATSHEET.md](CHEATSHEET.md)** - Быстрая шпаргалка
|
||
- **[CHANGELOG.md](CHANGELOG.md)** - История изменений
|
||
- **[DESCRIPTION.md](DESCRIPTION.md)** - Описание проекта
|
||
|
||
### Git Hooks
|
||
- **[gitea-hooks/README.md](gitea-hooks/README.md)** - Установка Git hooks
|
||
|
||
---
|
||
|
||
## 🇬🇧 English Documentation / Английская документация
|
||
|
||
### Main Guides / Основные руководства
|
||
- **[README_EN.md](README_EN.md)** - Complete Guide (Coming Soon)
|
||
- **[TESTING_GUIDE_EN.md](TESTING_GUIDE_EN.md)** - Testing Guide ✅
|
||
- **[GITEA_SYNC_EN.md](GITEA_SYNC_EN.md)** - Gitea → GitHub Sync ✅
|
||
- **[PROJECT_STRUCTURE_EN.md](PROJECT_STRUCTURE_EN.md)** - Project Structure ✅
|
||
|
||
### Reference / Справочная информация
|
||
- **[CHEATSHEET_EN.md](CHEATSHEET_EN.md)** - Quick Reference ✅
|
||
- **[CHANGELOG_EN.md](CHANGELOG_EN.md)** - Change History ✅
|
||
- **[DESCRIPTION.md](DESCRIPTION.md)** - Project Description (Bilingual) ✅
|
||
|
||
### Git Hooks
|
||
- **[gitea-hooks/README_EN.md](gitea-hooks/README_EN.md)** - Git Hooks Installation ✅
|
||
|
||
---
|
||
|
||
## 📖 Quick Links / Быстрые ссылки
|
||
|
||
### For Users / Для пользователей
|
||
| Topic | Russian | English |
|
||
|-------|---------|---------|
|
||
| Getting Started | [README.md](README.md) | [README_EN.md](README_EN.md) |
|
||
| Testing Certificates | [TESTING_GUIDE.md](TESTING_GUIDE.md) | [TESTING_GUIDE_EN.md](TESTING_GUIDE_EN.md) |
|
||
| Quick Commands | [CHEATSHEET.md](CHEATSHEET.md) | [CHEATSHEET_EN.md](CHEATSHEET_EN.md) |
|
||
|
||
### For Developers / Для разработчиков
|
||
| Topic | Russian | English |
|
||
|-------|---------|---------|
|
||
| Project Structure | [PROJECT_STRUCTURE.md](PROJECT_STRUCTURE.md) | [PROJECT_STRUCTURE_EN.md](PROJECT_STRUCTURE_EN.md) |
|
||
| Repository Sync | [GITEA_SYNC.md](GITEA_SYNC.md) | [GITEA_SYNC_EN.md](GITEA_SYNC_EN.md) |
|
||
| Changelog | [CHANGELOG.md](CHANGELOG.md) | [CHANGELOG_EN.md](CHANGELOG_EN.md) |
|
||
|
||
---
|
||
|
||
## 🚀 Quick Start / Быстрый старт
|
||
|
||
### Installation / Установка
|
||
```bash
|
||
sudo make install
|
||
sudo nano /etc/letsencrypt/regru_config.json
|
||
sudo make test-cert
|
||
```
|
||
|
||
### Documentation Priority / Приоритет документации
|
||
1. Start here / Начните здесь: **README.md** / **README_EN.md**
|
||
2. Testing / Тестирование: **TESTING_GUIDE.md** / **TESTING_GUIDE_EN.md**
|
||
3. Quick ref / Шпаргалка: **CHEATSHEET.md** / **CHEATSHEET_EN.md**
|
||
|
||
---
|
||
|
||
## 📊 Documentation Status / Статус документации
|
||
|
||
| File | Russian | English | Lines | Status |
|
||
|------|---------|---------|-------|--------|
|
||
| Main Guide | ✅ | 🔄 | 1,420+ | RU Complete |
|
||
| Testing Guide | ✅ | ✅ | 370+ | Both Complete |
|
||
| Cheatsheet | ✅ | ✅ | 200+ | Both Complete |
|
||
| Project Structure | ✅ | ✅ | 200+ | Both Complete |
|
||
| Gitea Sync | ✅ | ✅ | 400+ | Both Complete |
|
||
| Changelog | ✅ | ✅ | 150+ | Both Complete |
|
||
| Git Hooks | ✅ | ✅ | 100+ | Both Complete |
|
||
|
||
**Legend:**
|
||
- ✅ Complete / Готово
|
||
- 🔄 In Progress / В разработке
|
||
- ❌ Not Started / Не начато
|
||
|
||
---
|
||
|
||
## 🎯 Choose Your Language / Выберите язык
|
||
|
||
### Prefer Russian? / Предпочитаете русский?
|
||
👉 Начните с [README.md](README.md)
|
||
|
||
### Prefer English? / Предпочитаете английский?
|
||
👉 Start with [README_EN.md](README_EN.md) or [DESCRIPTION.md](DESCRIPTION.md)
|
||
|
||
---
|
||
|
||
## 💡 Contributing / Вклад
|
||
|
||
Help us translate / Помогите с переводом:
|
||
- [ ] Complete README_EN.md / Завершить README_EN.md
|
||
- [ ] Translate docs/ folder / Перевести папку docs/
|
||
|
||
---
|
||
|
||
**Last Updated / Обновлено**: October 27, 2025
|
||
**Maintained by / Поддерживает**: Фофанов Дмитрий
|