docs: Update main README to reference new documentation structure
- Add comprehensive documentation navigation section - Link to all 8 subdirectory READMEs (setup, architecture, roadmaps, etc.) - Organize by topic (performance, design, bugs, infrastructure) - Add status-based finding (completed, in progress, analysis) - Replace old flat list with category-based structure - Essential reading section highlights key documents
This commit is contained in:
45
README.md
45
README.md
@@ -977,19 +977,44 @@ docker compose logs -f trading-bot | grep "Position Manager"
|
||||
|
||||
---
|
||||
|
||||
## Documentation
|
||||
## 📚 Documentation
|
||||
|
||||
**Complete documentation available in `/docs/` directory - organized by category:**
|
||||
|
||||
### **📂 Quick Navigation**
|
||||
- **[docs/](docs/README.md)** - Main documentation hub with navigation
|
||||
- **[docs/setup/](docs/setup/)** - Setup guides & configuration
|
||||
- **[docs/architecture/](docs/architecture/)** - System design & technical details
|
||||
- **[docs/roadmaps/](docs/roadmaps/)** - Strategic planning & feature roadmaps
|
||||
- **[docs/analysis/](docs/analysis/)** - Performance analyses & optimization
|
||||
- **[docs/bugs/](docs/bugs/)** - Critical incidents & fixes
|
||||
- **[docs/deployments/](docs/deployments/)** - Deployment verification
|
||||
- **[docs/cluster/](docs/cluster/)** - Distributed computing & EPYC cluster
|
||||
- **[.github/copilot-instructions.md](.github/copilot-instructions.md)** - AI agent instructions (6,400+ lines)
|
||||
|
||||
### **🎯 Essential Reading**
|
||||
| Document | Purpose |
|
||||
|----------|---------|
|
||||
| `README.md` | Complete system overview (this file) |
|
||||
| `docs/SETUP.md` | Detailed setup instructions |
|
||||
| `docs/DOCKER.md` | Docker deployment guide |
|
||||
| `docs/TESTING.md` | Comprehensive testing guide |
|
||||
| `docs/TELEGRAM_BOT_README.md` | Telegram bot setup |
|
||||
| `docs/N8N_WORKFLOW_SETUP.md` | n8n workflow configuration |
|
||||
| `docs/PHASE_2_COMPLETE.md` | Phase 2 features and architecture |
|
||||
| `docs/QUICKREF_PHASE2.md` | Quick reference guide |
|
||||
| `.github/copilot-instructions.md` | AI agent instructions (architecture) |
|
||||
| [docs/setup/SIGNAL_QUALITY_SETUP_GUIDE.md](docs/setup/SIGNAL_QUALITY_SETUP_GUIDE.md) | TradingView alert configuration |
|
||||
| [docs/architecture/ADAPTIVE_LEVERAGE_SYSTEM.md](docs/architecture/ADAPTIVE_LEVERAGE_SYSTEM.md) | Risk management system |
|
||||
| [docs/roadmaps/OPTIMIZATION_MASTER_ROADMAP.md](docs/roadmaps/OPTIMIZATION_MASTER_ROADMAP.md) | Strategic vision |
|
||||
| [TRADING_GOALS.md](TRADING_GOALS.md) | Financial objectives ($106 → $100k+) |
|
||||
| [.github/copilot-instructions.md](.github/copilot-instructions.md) | Complete system reference |
|
||||
|
||||
### **🔍 Finding Documentation**
|
||||
**By Topic:**
|
||||
- Performance data → `docs/analysis/`
|
||||
- System design → `docs/architecture/`
|
||||
- Bug history → `docs/bugs/`
|
||||
- Infrastructure → `docs/cluster/`
|
||||
- Feature status → `docs/deployments/`
|
||||
- Future plans → `docs/roadmaps/`
|
||||
- Setup guides → `docs/setup/`
|
||||
|
||||
**By Status:**
|
||||
- ✅ Completed → Check `docs/deployments/*_COMPLETE.md`
|
||||
- 🔄 In Progress → Check `docs/roadmaps/` for phase status
|
||||
- 📊 Analysis → Check `docs/analysis/` for data insights
|
||||
|
||||
---
|
||||
|
||||
|
||||
Reference in New Issue
Block a user