docs: remove obsolete documentation files

This commit is contained in:
2026-07-02 16:31:48 +03:00
parent e08c604ff5
commit 3c336b10fb
4 changed files with 0 additions and 264 deletions

Binary file not shown.

View File

@@ -1,10 +0,0 @@
# Changelog
## v2.0.0
- создан стабильный bootstrap v2
- добавлена чистая структура проекта
- добавлено компактное верхнее меню 3 / 3 / 1
- добавлены базовые handlers
- help перенесен в раздел `Система`
- добавлены Docker-файлы
- добавлена стартовая документация

View File

@@ -1,189 +0,0 @@
# Git Setup Flow: dzentra_bot
## Полный процесс: от `git init` до первого `push` в Gitea
---
## 📍 0. Перейти в корень проекта
```bash
cd ~/vsprojects/dzentra_bot
pwd
```
Ожидаемо:
```
.../vsprojects/dzentra_bot
```
---
## 🧱 1. Инициализация Git
```bash
git init
```
Проверка:
```bash
git status
```
---
## 📦 2. Проверка `.gitignore`
```bash
cat .gitignore
```
Должны быть строки:
```
app/.env
app/.venv/
__pycache__/
.DS_Store
```
---
## 3. Добавить все файлы
```bash
git add .
```
Проверка:
```bash
git status
```
---
## 💾 4. Первый commit
```bash
git commit -m "bootstrap v2 stable start"
```
---
## 🔗 5. Подключить удалённый репозиторий (Gitea)
```bash
git remote add origin https://gitadmin@git.segeba.by/gitadmin/dzentra_bot.git
```
Проверка:
```bash
git remote -v
```
---
## 🌿 6. Установить ветку main
```bash
git branch -M main
```
---
## 🔐 7. Настроить сохранение токена (macOS)
```bash
git config --global credential.helper osxkeychain
```
---
## 🚀 8. Первый push
```bash
git push -u origin main
```
При запросе:
### Username:
```
gitadmin
```
### Password:
👉 вставить **Personal Access Token из Gitea**
---
## ✅ 9. Проверка
```bash
git status
git branch -vv
```
Проверить в Gitea — файлы должны появиться.
---
# 🔁 Дальнейшая работа
## Каждый цикл разработки
```bash
git status
git add .
git commit -m "описание изменения"
git push
```
---
# 🖥 Работа с проектом
## Запуск бота
```bash
cd app
source .venv/bin/activate
python -m src.main
```
## Git всегда из корня
```bash
cd ~/vsprojects/dzentra_bot
git status
```
---
# 🚀 Deploy на Synology
```bash
git pull
sudo docker compose -f infra/compose/docker-compose.yml up --build -d
```
---
# ⚠️ Важно
Не коммитить:
```
app/.env
app/.venv
ключи
пароли
логи
```
---
# 🎯 Итог
Git используется как:
- система контроля версий
- история проекта
- мост между Mac и Synology

View File

@@ -1,65 +0,0 @@
# 🧭 Терминология: биржа → UI бота → код
| 🏦 Термин биржи | 🤖 UI бота (как показываем) | 🧠 В коде (модель) | 💬 Комментарий |
|------------------------------|------------------------------------|--------------------------------|---------------|
| Купить | Купить (LONG) | `side = "BUY"` | Открытие long |
| Продать | Продать (SHORT) | `side = "SELL"` | Открытие short |
| Режим левереджа | 📈 Левередж | `trade_mode = "leverage"` | Основной режим |
| Режим торгов | 💱 Торги / Спот | `trade_mode = "spot"` | Без плеча |
| Купить сейчас | ⚡ MARKET | `order_type = "MARKET"` | Исполнение сразу |
| Купить когда цена = X | 🎯 LIMIT | `order_type = "LIMIT"` | Отложенный ордер |
| Цена | Цена | `price` | Только для LIMIT |
| Количество / Размер | Количество | `quantity` | Базовая величина |
| % от баланса | 5% / 10% / ... | `quantity` (расчёт) | UI-обёртка |
| Левередж | Плечо | `leverage` | Пока нет в модели |
| Доступно | Доступно | `available_balance` | из context |
| Ориентир цены (Last/Bid/Ask) | Ориентир цены | `reference_price` | для UI |
| Стоп-лосс | Стоп-лосс | `stop_loss` | будущий параметр |
| Тейк-профит | Тейк-профит | `take_profit` | будущий параметр |
| Сумма ордера | Сумма | `notional` | `price * quantity` |
| Мин. сумма | Мин. сумма | `min_notional` | правило биржи |
| Шаг количества | Шаг | `step_size` | правило |
| Мин. количество | Минимум | `min_qty` | правило |
| Черновик | Черновик | `draft` | статус |
| Подтвердить | Подтвердить | — | UI-действие |
---
## 🔥 Основные принципы
### 1. UI ≠ код
- UI: язык биржи (понятный пользователю)
- Код: строгая техническая модель
---
### 2. MARKET / LIMIT — это тип ордера
- не путать с режимом торговли (левередж / спот)
---
### 3. LONG / SHORT
- LONG = `BUY`
- SHORT = `SELL`
---
### 4. Текущий статус модели
✔ Уже есть:
- `side`
- `order_type`
- `quantity`
- `price`
🔜 Нужно добавить:
- `leverage`
- `stop_loss`
- `take_profit`
---
## 🧭 Итог
Пользователь видит **терминологию биржи**,
система работает на **нормализованной модели**.