mirror of
https://github.com/NoFxAiOS/nofx.git
synced 2026-06-06 05:51:19 +08:00
261e0d47ad
Addressed review feedback on PR #226: - FAQ and TROUBLESHOOTING serve different purposes and should both be kept - FAQ: Quick Q&A format for common questions (now expanded) - TROUBLESHOOTING: Detailed step-by-step diagnostic guide Changes: - Expanded FAQ from 26 lines to 200+ lines with 7 sections: * General Questions (What is NOFX, supported exchanges, profitability) * Setup & Configuration (requirements, API keys, subaccounts) * Trading Questions (decision frequency, position limits, customization) * Technical Issues (quick fixes for common errors) * AI & Model Questions (supported models, costs, learning) * Data & Privacy (storage, security, export) * Contributing (how to help, feature requests) - Added cross-references between FAQ and TROUBLESHOOTING - FAQ provides quick answers with links to detailed troubleshooting - TROUBLESHOOTING remains comprehensive diagnostic guide Both English and Chinese versions updated. Fixes review comment from @reviewer on PR #226 Co-Authored-By: tinkle-community <tinklefund@gmail.com>
📘 NOFX User Guides
Comprehensive guides to help you use NOFX effectively.
📚 Available Guides
🔧 Basic Usage
| Guide | Description | Status |
|---|---|---|
| FAQ (English) | Frequently asked questions | ✅ Available |
| FAQ (中文) | 常见问题解答 | ✅ Available |
| Configuration Guide | Advanced settings and options | 🚧 Coming Soon |
| Trading Strategies | AI trading strategy examples | 🚧 Coming Soon |
🐛 Troubleshooting
Common Issues
Issue: TA-Lib not found
# macOS
brew install ta-lib
# Ubuntu/Debian
sudo apt-get install libta-lib0-dev
Issue: Precision error
- System auto-handles LOT_SIZE from exchange
- Check network connection
- Verify exchange API is accessible
Issue: AI API timeout
- Check API key validity
- Verify network connection
- Check API balance/credits
- Timeout is set to 120 seconds
Issue: Frontend can't connect
- Ensure backend is running (http://localhost:8080)
- Check if port 8080 is available
- Check browser console for errors
📖 Usage Tips
Best Practices
1. Risk Management
- Start with small amounts (100-500 USDT)
- Use subaccounts for additional safety
- Set reasonable leverage limits
- Monitor daily loss limits
2. Performance Monitoring
- Check decision logs regularly
- Analyze win rate and profit factor
- Review AI reasoning (Chain of Thought)
- Track equity curve trends
3. Configuration
- Test on testnet first
- Gradually increase trading amounts
- Adjust scan intervals (3-5 minutes recommended)
- Use default coin list for beginners
🎯 Advanced Topics
Multi-Trader Competition
Run multiple AI models simultaneously:
- Qwen vs DeepSeek head-to-head
- Compare performance in real-time
- Identify best-performing strategies
Custom Coin Pools
- Use external API for coin selection
- Combine AI500 + OI Top data
- Filter by liquidity and volume
Exchange Integration
- Binance Futures (CEX)
- Hyperliquid (DEX)
- Aster DEX (Binance-compatible)
📊 Understanding Metrics
Key Performance Indicators
Win Rate
- Percentage of profitable trades
- Target: >50% for consistent profit
Profit Factor
- Ratio of gross profit to gross loss
- Target: >1.5 (1.5:1 or better)
Sharpe Ratio
- Risk-adjusted return measure
- Higher is better (>1.0 is good)
Maximum Drawdown
- Largest peak-to-trough decline
- Keep under 20% for safety
🔗 Related Documentation
- Getting Started (EN) - Initial setup
- Getting Started (中文) - 初始设置
- Community - Contributing and bounties
- FAQ (English) - Common questions
- FAQ (中文) - 常见问题
🆘 Need Help?
Can't find what you need?