Update documentation to use placeholder values instead of real credentials
in example configurations for enhanced security.
Co-Authored-By: tinkle-community <tinklefund@gmail.com>
Enhanced the Exchange API errors section with more detailed solutions
for timestamp-related failures, based on Issue #60.
Problem:
- code=-1021: Timestamp outside of recvWindow
- System time not synced with Binance servers
- Docker container time drift
Enhanced Solutions:
1. System Time Sync (Multiple methods)
- ntpdate pool.ntp.org (recommended)
- ntpdate with different NTP servers
- timedatectl for automatic sync
- Aliyun NTP for China users
2. Docker-specific fixes
- Check container time vs host time
- Restart Docker service
- Add TZ environment variable
3. API Key verification steps
- Regeneration procedure
- Permission checklist
4. Rate limit considerations
- Reduce trader count
- Increase decision interval
Both English and Chinese versions updated.
Fixes: #60
Co-Authored-By: tinkle-community <tinklefund@gmail.com>
Added comprehensive troubleshooting guide for Docker image pull failures
in mainland China, based on Issue #168.
Problem:
- Users in China cannot pull Docker images from Docker Hub
- ERROR: load metadata for docker.io/library/...
- Timeouts and connection failures
Solutions Added:
1. Configure Docker registry mirrors (Recommended)
- List of working China mirrors
- Step-by-step configuration for Linux/macOS/Windows
- Verification commands
2. Use VPN
- Taiwan nodes recommended
- Global mode required
3. Offline image download
- Image proxy websites
- Manual import instructions
Both English and Chinese versions updated.
Fixes: #168
Co-Authored-By: tinkle-community <tinklefund@gmail.com>
Fixed incorrect information about supported AI models:
Before (Incorrect):
- Listed OpenAI GPT-4 and Claude as directly supported
- These are NOT natively supported
After (Correct):
- DeepSeek (native support, recommended)
- Qwen (native support, Alibaba Cloud)
- Custom OpenAI-compatible APIs (can use OpenAI, Claude via proxy, etc.)
Also updated cost estimates to reflect actual supported models.
Reference: mcp/client.go shows only DeepSeek, Qwen, and Custom providers.
Co-Authored-By: tinkle-community <tinklefund@gmail.com>
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>
