Commit Graph

42 Commits

Author SHA1 Message Date
tinkle-community
ff54731ccf update docs 2025-11-24 00:04:45 +08:00
tinkle-community
fad279bee1 update Korean README docs 2025-11-23 22:04:02 +08:00
tinkle-community
33dce4edcc update Korean README docs 2025-11-23 21:58:50 +08:00
tinkle-community
52fb1c902c update docs 2025-11-23 21:13:27 +08:00
tinkle-community
c258abb292 update docs 2025-11-23 21:10:37 +08:00
tinkle-community
f1397c7891 update docs 2025-11-19 22:49:50 +08:00
Burt
91b7187e25 Git 工作流规范 (#974)
* Add files via upload

* Revise Git workflow guidelines and branch strategies

* Update git workflow

* Chores
2025-11-15 22:20:06 -05:00
tinkle-community
20aa054bf3 update readme 2025-11-15 22:20:06 -05:00
Lawrence Liu
34cb7b1bbd Revert "fix(api): market/combined_streams: Get Proxy form Environment (#879)" (#985)
This reverts commit 183e9273b8.
2025-11-15 22:20:06 -05:00
Dongyan Qian
e0af0d96e0 fix(api): market/combined_streams: Get Proxy form Environment (#879)
* fix(api): market/combined_streams: Get Proxy form Environment

issues:
 批量订阅流失败: 组合流WebSocket连接失败: dial tcp xxxxxx:443: i/o timeout

Make environment variables effective for
dialer.Dial("wss://fstream.binance.com/stream", nil):

export HTTPS_PROXY=http://ip:port
export HTTP_PROXY=http://ip:port

Signed-off-by: MarsDoge <mars@dogexorg.com>

* docs(WebSocket): add proxy usage guidance for combined streams (#475)

Signed-off-by: MarsDoge <mars@dogexorg.com>

---------

Signed-off-by: MarsDoge <mars@dogexorg.com>
2025-11-15 22:20:06 -05:00
tinkle-community
9fc1870f5f update readme 2025-11-15 22:20:06 -05:00
Diego
fc8a4d3d63 fix(stats): fixed the PNL calculation (#963) 2025-11-15 22:20:06 -05:00
Shui
970cfaadf3 Fix(readme): modify docoments (#956)
* fix(trader): get peakPnlPct using posKey

* fix(docs): keep readme at the same page

---------

Co-authored-by: zbhan <zbhan@freewheel.tv>
2025-11-15 22:20:06 -05:00
tinkle-community
f8d1cbb670 update readme 2025-11-15 22:17:11 -05:00
Icy
190b0c29d4 merge dev 2025-11-12 23:40:58 +08:00
tinkle-community
dc678a27bc Feat/hyperliquid agent wallet docs (#936)
* feat(docs): add Hyperliquid Agent Wallet tutorial for all languages

- Add comprehensive Hyperliquid Agent Wallet setup guide with referral link
- Update all 5 language versions (EN, ZH, JA, RU, UK)
- Remove "Alternative" prefix from Hyperliquid and Aster DEX section titles
- Remove direct wallet method, only recommend secure Agent Wallet approach
- Include step-by-step registration, funding, and agent wallet creation
- Add security warnings and best practices for all languages

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: tinkle-community <tinklefund@gmail.com>

* feat(docs): add Hyperliquid and Aster DEX to Table of Contents in all languages

- Add navigation links for Hyperliquid and Aster DEX registration in all 5 README versions
- Ensure all three exchanges (Binance, Hyperliquid, Aster) have equal visibility in TOC
- Add complete TOC structure to Japanese README (was missing before)
- Maintain consistency across English, Chinese, Japanese, Russian, and Ukrainian versions

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: tinkle-community <tinklefund@gmail.com>

---------

Co-authored-by: tinkle <tinkle@tinkle.community>
Co-authored-by: tinkle-community <tinklefund@gmail.com>
2025-11-12 19:05:04 +08:00
tinkle-community
7ea46421c6 feat(docs): add Hyperliquid Agent Wallet tutorial for all languages (#935)
- Add comprehensive Hyperliquid Agent Wallet setup guide with referral link
- Update all 5 language versions (EN, ZH, JA, RU, UK)
- Remove "Alternative" prefix from Hyperliquid and Aster DEX section titles
- Remove direct wallet method, only recommend secure Agent Wallet approach
- Include step-by-step registration, funding, and agent wallet creation
- Add security warnings and best practices for all languages

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: tinkle <tinkle@tinkle.community>
Co-authored-by: tinkle-community <tinklefund@gmail.com>
2025-11-12 18:29:37 +08:00
CoderMageFox
f8068f9e24 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.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: tinkle-community <tinklefund@gmail.com>
2025-11-10 14:03:17 +08:00
CoderMageFox
e0535d8889 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

🤖 Generated with [Claude Code](https://claude.com/claude-code)

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

🤖 Generated with [Claude Code](https://claude.com/claude-code)

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
40030fd1b6 Add Terms of Service (#656)
* Add Privacy Policy

* Add Terms of Service
2025-11-07 02:16:05 +08:00
SkywalkerJi
494754c120 Add Privacy Policy (#655) 2025-11-07 01:54:25 +08:00
icy
706c719248 chore: move shell scripts under scripts/ and update docs 2025-11-06 17:53:27 +08:00
icy
8e7e50ef5f refactor: drop sqlite fallback and admin mode 2025-11-06 17:52:30 +08:00
icy
579c73a81b chore: remove pm2 deployment docs and tooling 2025-11-06 17:47:40 +08:00
icy
65053518d6 feat: implement hybrid database architecture and frontend encryption
- Add PostgreSQL + SQLite hybrid database support with automatic switching
- Implement frontend AES-GCM + RSA-OAEP encryption for sensitive data
- Add comprehensive DatabaseInterface with all required methods
- Fix compilation issues with interface consistency
- Update all database method signatures to use DatabaseInterface
- Add missing UpdateTraderInitialBalance method to PostgreSQL implementation
- Integrate RSA public key distribution via /api/config endpoint
- Add frontend crypto service with proper error handling
- Support graceful degradation between encrypted and plaintext transmission
- Add directory creation for RSA keys and PEM parsing fixes
- Test both SQLite and PostgreSQL modes successfully

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: tinkle-community <tinklefund@gmail.com>
2025-11-06 01:50:06 +08:00
SkywalkerJi
aebdf120b0 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
5f98e09920 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
400c888e52 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
186908ff4e docs: config.example.jsonc替换成config.json.example 2025-11-05 09:24:38 +08:00
zbhan
0fb9fa8a2e fix(readme): update readme and pr reviewer 2025-11-03 20:50:56 -05:00
Luna Martinez
26a170935a 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
0eba15deda docs: Replace sensitive configuration examples with placeholders
Update documentation to use placeholder values instead of real credentials
in example configurations for enhanced security.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: tinkle-community <tinklefund@gmail.com>
2025-11-03 03:47:41 +08:00
yuanshi2016
5e0706bee3 修改Kline获取方式为Websocket缓存。 2025-11-02 17:59:19 +08:00
tinkle-community
13e90118d4 update aster exchange guide 2025-11-02 12:23:33 +08:00
Liu Xiang Qian
e4822d11e5 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

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: tinkle-community <tinklefund@gmail.com>
2025-11-02 11:44:57 +08:00
Liu Xiang Qian
aca0af519d 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

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: tinkle-community <tinklefund@gmail.com>
2025-11-02 11:38:53 +08:00
Liu Xiang Qian
df7386c028 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.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: tinkle-community <tinklefund@gmail.com>
2025-11-02 11:09:18 +08:00
Liu Xiang Qian
edc349fb4e 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

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: tinkle-community <tinklefund@gmail.com>
2025-11-02 11:04:58 +08:00
Xeron
4210656856 Fix broken DashScope link in README files (fixes #128) 2025-11-02 10:56:24 +08:00
Liu Xiang Qian
b27bad4d74 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.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: tinkle-community <tinklefund@gmail.com>
2025-11-02 10:19:19 +08:00
zbhan
a1bf54b952 feat: pr validation 2025-11-01 18:25:44 -04:00
zbhan
2351bb95c3 Feat: Update docs
- 重构文档结构
- 更新文档内容
- 制定roadmap
- 提供中/EN 双语文档
2025-11-01 15:05:24 -04:00