# 📖 Documentation Index **Complete guide to the Hyperliquid Trading Bot - organized for quick navigation** ## 🚀 **Quick Start** (5 minutes) **[📖 Setup Guide](setup.md)** - Get trading in 5 minutes with step-by-step installation ## 📱 **Daily Usage** **[📖 Commands Reference](commands.md)** - Complete command guide with examples and mobile optimization ## 🏗️ **Technical Reference** **[📖 Project Structure](project-structure.md)** - Detailed architecture and module breakdown **[📖 System Integration](system-integration.md)** - Advanced integration and customization **[📖 Position Notifications](position-notifications.md)** - Enhanced position tracking and notifications ## 🚀 **Production Deployment** **[📖 Deployment Guide](deployment.md)** - Server setup, process management, and monitoring ## 📋 **Documentation Overview** | Guide | Purpose | Time Estimate | Audience | |-------|---------|---------------|----------| | **[setup.md](setup.md)** | **5-minute installation** | 5 minutes | All users | | **[commands.md](commands.md)** | **Daily trading commands** | 10 minutes | Traders | | **[project-structure.md](project-structure.md)** | **Code architecture** | 15 minutes | Developers | | **[system-integration.md](system-integration.md)** | **Advanced setup** | 20 minutes | Advanced users | | **[position-notifications.md](position-notifications.md)** | **Position tracking features** | 10 minutes | Traders & Developers | | **[deployment.md](deployment.md)** | **Production setup** | 30 minutes | System admins | ## 🎯 **What You'll Find in Each Guide** ### **📖 setup.md** - ✅ 5-minute quick start - ✅ Environment configuration - ✅ Telegram bot setup - ✅ First trade walkthrough ### **📖 commands.md** - 📱 All trading commands with examples - 🔔 Monitoring and alert commands - 📊 Statistics and reporting commands - 💡 Pro tips and workflows ### **📖 project-structure.md** - 🏗️ Complete directory structure - 📦 Module organization and responsibilities - 🔧 Architecture principles and benefits - 🆕 Enhanced stop loss management details ### **📖 system-integration.md** - 🔧 Advanced configuration options - 🔌 API integration patterns - 🛡️ Security considerations - 🔄 Custom workflow setup ### **📖 position-notifications.md** - 🔔 Enhanced position tracking system - 📊 Distinct notification types (opened/closed/increased/decreased) - 💰 Real-time P&L calculations - 🎯 Reduced notification noise ### **📖 deployment.md** - 🚀 Production server setup - 📊 Process management and monitoring - 🔒 Security hardening - 📈 Performance optimization ## 💡 **Navigation Tips** - **New users**: Start with [setup.md](setup.md) - **Daily traders**: Bookmark [commands.md](commands.md) - **Developers**: Review [project-structure.md](project-structure.md) - **Production users**: Follow [deployment.md](deployment.md) ## 🔗 **External Resources** - **[Main Project README](../README.md)** - Project overview and features - **[CCXT Documentation](https://github.com/ccxt/ccxt)** - Exchange API standards - **[Hyperliquid API](https://hyperliquid.gitbook.io/hyperliquid-docs)** - Official API docs - **[Python Telegram Bot](https://python-telegram-bot.readthedocs.io/)** - Bot framework docs **Happy trading! 🚀📱**