Commit Graph

21 Commits

Author SHA1 Message Date
CoderMageFox 2b3d064e6c docs: improve override_base_prompt explanation and update maintainer (#852)
- Add visual diagrams to explain override_base_prompt behavior
- Clarify the difference between "append" (false) and "replace" (true) modes
- Add warning messages for advanced users about risks
- Update maintainer to "Nofx Team CoderMageFox"
- Improve both English and Chinese documentation
This change addresses user confusion about the override_base_prompt setting
by providing clear visual explanations and practical examples.
Co-authored-by: tinkle-community <tinklefund@gmail.com>
2025-11-10 14:03:17 +08:00
CoderMageFox f7498ef346 docs(prompt): add comprehensive prompt writing guide (#837)
* docs: 添加 Prompt 编写指南并更新 README 导航
为 NoFx 系统创建完整的 Prompt 编写指南文档,帮助用户编写高质量的自定义 AI 交易策略提示词。
主要内容:
- 📚 快速开始指南(5分钟上手)
- 💡 核心概念和工作原理
- 📋 完整的可用字段参考(系统状态、账户信息、持仓信息等)
- ⚖️ 系统约束和规则说明
- 📦 三种官方策略模板(保守型/平衡型/激进型)
-  质量检查清单(20+ 检查项)
-  10个常见错误案例和最佳实践
- 🎓 高级话题(完全自定义、调试指南)
文档特点:
- 基于实际代码(decision/engine.go)确保字段准确性
- 三层用户分级(新手/进阶/高级)
- 完整的策略模板即拿即用
-  对比示例避免常见错误
- 20,000+ 字完整覆盖所有关键知识点
同时更新 README.md 添加文档导航链接,方便用户快速访问。
Fixes #654
Co-Authored-By: tinkle-community <tinklefund@gmail.com>
* docs(prompt): add i18n support with complete English translation
完善 Prompt 编写指南的国际化支持,添加完整的英文翻译版本。
主要更改:
- 📝 新增英文版本:docs/prompt-guide.md
- 🇨🇳 中文版本重命名:docs/prompt-guide.zh-CN.md
- 🔗 更新 README.md 文档链接,标注语言选项
文档特点:
- 完整翻译所有章节(20,000+ 字)
- 保持中英文结构完全一致
- 遵循项目 i18n 惯例(参考 docs/guides/)
- 便于不同语言用户使用
Related to #654
Co-Authored-By: tinkle-community <tinklefund@gmail.com>
---------
Co-authored-by: tinkle-community <tinklefund@gmail.com>
2025-11-10 11:44:17 +08:00
SkywalkerJi 5f949afd29 Add Terms of Service (#656)
* Add Privacy Policy
* Add Terms of Service
2025-11-07 02:16:05 +08:00
SkywalkerJi e570793d40 Add Privacy Policy (#655) 2025-11-07 01:54:25 +08:00
SkywalkerJi 0abfd13dbf fix: Fix README link (#563)
* Resolved front-end linting issues.
* Streamlining Docker Build Scripts
* Leveraging Native ARM64 Runners on GitHub.
* Use lowercase framework names.
* Streamlining dependencies within the README.
2025-11-06 00:31:05 +08:00
Burt 8b853a963d Feat: Enable admin password in admin mode (#540)
* WIP: save local changes before merging
* Enable admin password in admin mode #374
2025-11-05 21:48:28 +08:00
SkywalkerJi c76780d850 Add ja docs (#530)
* docs: add Japanese README
* docs: Update README.ja.md
* docs: add DOCKER_DEPLOY.ja.md
---------
Co-authored-by: Ikko Ashimine <ashimine_ikko_bp@tenso.com>
2025-11-05 20:14:26 +08:00
liangjiahao 5efc9fc7c5 docs: config.example.jsonc替换成config.json.example 2025-11-05 09:24:38 +08:00
zbhan 52295c69ad fix(readme): update readme and pr reviewer 2025-11-03 20:50:56 -05:00
Luna Martinez 35316d61f7 Merge pull request #226 from xqliu/docs/enhance-bug-report-template
docs: Enhance bug report template and add troubleshooting guide
2025-11-02 21:08:32 -05:00
tinkle-community f5dc441c20 docs: Replace sensitive configuration examples with placeholders
Update documentation to use placeholder values instead of real credentials
in example configurations for enhanced security.
Co-Authored-By: tinkle-community <tinklefund@gmail.com>
2025-11-03 03:47:41 +08:00
yuanshi2016 d8582475d3 修改Kline获取方式为Websocket缓存。 2025-11-02 17:59:19 +08:00
tinkle-community 22cc35f1d8 update aster exchange guide 2025-11-02 12:23:33 +08:00
Liu Xiang Qian dee040e35b docs: Enhance timestamp/timezone troubleshooting based on Issue #60
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>
2025-11-02 11:44:57 +08:00
Liu Xiang Qian 24855b4859 docs: Add Docker image pull failure troubleshooting (China)
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>
2025-11-02 11:38:53 +08:00
Liu Xiang Qian d8a5a9e143 docs: Fix AI model list in FAQ - correct supported models
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>
2025-11-02 11:09:18 +08:00
Liu Xiang Qian 261e0d47ad docs: Expand FAQ and clarify separation from TROUBLESHOOTING
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>
2025-11-02 11:04:58 +08:00
Xeron 48ee2e3eca Fix broken DashScope link in README files (fixes #128) 2025-11-02 10:56:24 +08:00
Liu Xiang Qian b1a0f015d7 docs: Enhance bug report template and add comprehensive troubleshooting guide
- Enhanced bug report template with detailed log capture instructions
  - Added bug categorization system (6 main categories)
  - Frontend error capture guide (DevTools Console/Network tabs)
  - Backend log capture for Docker and PM2 deployments
  - Trading/decision logs location and usage
  - Comprehensive environment information checklist
  - Quick diagnostic tips for faster issue resolution
- Created bilingual troubleshooting guides (EN/ZH)
  - Common trading issues (e.g., Issue #202: only short positions)
  - Detailed explanation of Binance position mode requirements
  - AI decision problems and diagnostics
  - Connection and API error solutions
  - Frontend and database issues
  - Complete log capture instructions with commands
  - Emergency reset procedures
- Updated documentation cross-references
  - Added troubleshooting guide links to bug report template
  - Added links in README Common Issues section
  - Bilingual support for better accessibility
This reduces maintainer workload by helping users self-diagnose issues
and submit higher-quality bug reports with all necessary information.
Addresses Issue #202 root cause documentation.
Co-Authored-By: tinkle-community <tinklefund@gmail.com>
2025-11-02 10:19:19 +08:00
zbhan 2f4f277001 feat: pr validation 2025-11-01 18:25:44 -04:00
zbhan fcacfbd79d Feat: Update docs
- 重构文档结构
- 更新文档内容
- 制定roadmap
- 提供中/EN 双语文档
2025-11-01 15:05:24 -04:00