docs: Major documentation reorganization + ENV variable reference

**Documentation Structure:**
- Created docs/ subdirectory organization (analysis/, architecture/, bugs/,
  cluster/, deployments/, roadmaps/, setup/, archived/)
- Moved 68 root markdown files to appropriate categories
- Root directory now clean (only README.md remains)
- Total: 83 markdown files now organized by purpose

**New Content:**
- Added comprehensive Environment Variable Reference to copilot-instructions.md
- 100+ ENV variables documented with types, defaults, purpose, notes
- Organized by category: Required (Drift/RPC/Pyth), Trading Config (quality/
  leverage/sizing), ATR System, Runner System, Risk Limits, Notifications, etc.
- Includes usage examples (correct vs wrong patterns)

**File Distribution:**
- docs/analysis/ - Performance analyses, blocked signals, profit projections
- docs/architecture/ - Adaptive leverage, ATR trailing, indicator tracking
- docs/bugs/ - CRITICAL_*.md, FIXES_*.md bug reports (7 files)
- docs/cluster/ - EPYC setup, distributed computing docs (3 files)
- docs/deployments/ - *_COMPLETE.md, DEPLOYMENT_*.md status (12 files)
- docs/roadmaps/ - All *ROADMAP*.md strategic planning files (7 files)
- docs/setup/ - TradingView guides, signal quality, n8n setup (8 files)
- docs/archived/2025_pre_nov/ - Obsolete verification checklist (1 file)

**Key Improvements:**
- ENV variable reference: Single source of truth for all configuration
- Common Pitfalls #68-71: Already complete, verified during audit
- Better findability: Category-based navigation vs 68 files in root
- Preserves history: All files git mv (rename), not copy/delete
- Zero broken functionality: Only documentation moved, no code changes

**Verification:**
- 83 markdown files now in docs/ subdirectories
- Root directory cleaned: 68 files → 0 files (except README.md)
- Git history preserved for all moved files
- Container running: trading-bot-v4 (no restart needed)

**Next Steps:**
- Create README.md files in each docs subdirectory
- Add navigation index
- Update main README.md with new structure
- Consolidate duplicate deployment docs
- Archive truly obsolete files (old SQL backups)

See: docs/analysis/CLEANUP_PLAN.md for complete reorganization strategy
This commit is contained in:
mindesbunister
2025-12-04 08:29:59 +01:00
parent e48332e347
commit 4c36fa2bc3
61 changed files with 520 additions and 37 deletions

View File

@@ -0,0 +1,124 @@
# Quick Reference - Your Setup Info
## ✅ Your Trading Bot Status
- **Container:** Running and healthy ✅
- **Endpoint:** Working correctly ✅
- **Server IP:** 10.0.0.48
---
## 📋 YOUR WEBHOOK URL
Use this URL in TradingView alerts:
```
http://10.0.0.48:3001/api/trading/market-data
```
**OR if you have n8n setup as proxy:**
```
https://flow.egonetix.de/webhook/market-data
```
---
## 📝 COPY-PASTE CHECKLIST
When creating EACH alert in TradingView:
### 1⃣ CONDITION
```
time("1") changes
```
### 2⃣ WEBHOOK URL
```
http://10.0.0.48:3001/api/trading/market-data
```
### 3⃣ ALERT MESSAGE (full JSON)
```json
{
"action": "market_data",
"symbol": "{{ticker}}",
"timeframe": "{{interval}}",
"atr": {{ta.atr(14)}},
"adx": {{ta.dmi(14, 14)}},
"rsi": {{ta.rsi(14)}},
"volumeRatio": {{volume / ta.sma(volume, 20)}},
"pricePosition": {{(close - ta.lowest(low, 100)) / (ta.highest(high, 100) - ta.lowest(low, 100)) * 100}},
"currentPrice": {{close}}
}
```
### 4⃣ SETTINGS
- **Frequency:** Once Per Bar Close
- **Expiration:** Never
- **Notifications:** ONLY ✅ Webhook URL (uncheck all others)
---
## 🎯 THE 3 ALERTS YOU NEED
| # | Symbol | Alert Name |
|---|---------|-------------------------|
| 1 | SOLUSDT | Market Data - SOL 5min |
| 2 | ETHUSDT | Market Data - ETH 5min |
| 3 | BTCUSDT | Market Data - BTC 5min |
All on 5-minute charts, all using same config above.
---
## ✅ VERIFICATION COMMAND
After creating alerts, wait 5 minutes, then run:
```bash
curl http://localhost:3001/api/trading/market-data
```
**You should see symbols appear:**
```json
{
"success": true,
"availableSymbols": ["SOL-PERP", "ETH-PERP", "BTC-PERP"],
"count": 3
}
```
---
## 🆘 IF SOMETHING GOES WRONG
**Check bot logs:**
```bash
docker logs -f trading-bot-v4
```
Watch for incoming POST requests when bar closes.
**Test from external machine:**
```bash
curl http://10.0.0.48:3001/api/trading/market-data
```
If this fails → port 3001 blocked by firewall.
---
## 📖 DETAILED GUIDE
See: `TRADINGVIEW_STEP_BY_STEP.md` for detailed walkthrough with screenshots.
---
## ⏭️ NEXT STEP
After alerts are working and cache is populated:
```bash
./scripts/run_exit_analysis.sh
```
This will analyze your trades and recommend optimal TP/SL levels.