Feat: Update docs

- 重构文档结构
- 更新文档内容
- 制定roadmap
- 提供中/EN 双语文档
This commit is contained in:
zbhan
2025-11-01 15:05:24 -04:00
parent 5db58b06c1
commit 2351bb95c3
36 changed files with 5756 additions and 1149 deletions

203
CHANGELOG.zh-CN.md Normal file
View File

@@ -0,0 +1,203 @@
# 更新日志
NOFX 项目的所有重要更改都将记录在此文件中。
本文件格式基于 [Keep a Changelog](https://keepachangelog.com/zh-CN/1.0.0/)
本项目遵循 [语义化版本](https://semver.org/lang/zh-CN/)。
**语言:** [English](CHANGELOG.md) | [中文](CHANGELOG.zh-CN.md)
---
## [未发布]
### 新增
- 多语言文档系统(英文/中文/俄语/乌克兰语)
- 完整的快速开始指南Docker、PM2、自定义 API
- 架构文档,包含系统设计细节
- 用户指南,包含 FAQ 和故障排除
- 社区文档,包含悬赏计划
### 变更
- 重组文档结构为逻辑分类
- 更新所有 README 文件,添加适当的导航链接
---
## [3.0.0] - 2025-10-30
### 新增 - 重大架构变革 🚀
**系统完全重新设计 - 基于 Web 的配置平台**
这是一个**重大破坏性更新**,将 NOFX 从基于静态配置的系统完全转变为现代化的 Web 交易平台。
#### 数据库驱动架构
- SQLite 集成,取代静态 JSON 配置
- 持久化存储,自动时间戳
- 外键关系和触发器确保数据一致性
- 为 AI 模型、交易所、交易员和系统配置分离表结构
#### 基于 Web 的配置界面
- 完整的 Web 配置管理(无需编辑 JSON
- 通过 Web 界面设置 AI 模型DeepSeek/Qwen API 密钥)
- 交易所管理Binance/Hyperliquid 凭证)
- 动态创建交易员(结合任意 AI 模型和交易所)
- 实时控制(无需重启即可启动/停止交易员)
#### 灵活架构
- 关注点分离AI 模型和交易所独立)
- 混合搭配能力(无限组合)
- 可扩展设计(支持无限交易员)
- 清洁起点(无默认交易员)
#### 增强的 API 层
- RESTful 设计,完整的 CRUD 操作
- 新端点:
- `GET/PUT /api/models` - AI 模型配置
- `GET/PUT /api/exchanges` - 交易所配置
- `POST/DELETE /api/traders` - 交易员管理
- `POST /api/traders/:id/start|stop` - 交易员控制
- 更新所有 API 端点文档
#### 现代化代码库
- 类型安全,适当分离配置类型
- 数据库抽象,使用预处理语句
- 全面的错误处理和验证
- 更好的代码组织数据库、API、业务逻辑
### 变更
- **破坏性变更**:不再使用旧的 `config.json` 文件
- 必须通过 Web 界面进行配置
- 设置更简单,用户体验更好
- 配置更改无需重启服务器
### 为什么重要
- 🎯 **用户体验**:配置和管理更容易
- 🔧 **灵活性**:创建 AI 模型和交易所的任意组合
- 📊 **可扩展性**:支持复杂的多交易员设置
- 🔒 **可靠性**:数据库确保数据持久性和一致性
- 🚀 **面向未来**:为高级功能奠定基础
---
## [2.0.2] - 2025-10-29
### 修复 - 关键错误修复:交易历史和性能分析
#### 盈亏计算 - 重大错误修复
- **修复**:盈亏现在计算为实际 USDT 金额,而不是仅百分比
- 之前忽略了仓位大小和杠杆例如100 USDT @ 5% = 1000 USDT @ 5%
- 现在:`盈亏 (USDT) = 仓位价值 × 价格变化 % × 杠杆`
- 影响:胜率、盈利因子和夏普比率现在准确
#### 仓位跟踪 - 缺失关键数据
- **修复**:持仓记录现在存储数量和杠杆
- 之前只存储价格和时间
- 这对准确的盈亏计算至关重要
#### 仓位键逻辑 - 多空冲突
- **修复**:从 `symbol` 改为 `symbol_side` 格式
- 现在正确区分多头和空头仓位
- 示例:`BTCUSDT_long` vs `BTCUSDT_short`
#### 夏普比率计算 - 代码优化
- **变更**:用 `math.Sqrt` 替换自定义牛顿法
- 更可靠、可维护和高效
### 为什么重要
- 历史交易统计现在显示真实的 USDT 盈亏
- 不同杠杆交易之间的性能比较准确
- AI 自学习机制接收正确的反馈
- 多仓位跟踪(同时多空)正常工作
---
## [2.0.2] - 2025-10-29
### 修复 - Aster 交易所精度错误
- 修复 Aster 交易所精度错误(代码 -1111
- 改进价格和数量格式化以匹配交易所要求
- 添加详细的精度处理日志用于调试
- 增强所有订单函数的精度处理
#### 技术细节
- 添加 `formatFloatWithPrecision` 函数
- 根据交易所规范格式化价格和数量
- 删除尾随零以优化 API 请求
---
## [2.0.1] - 2025-10-29
### 修复 - ComparisonChart 数据处理
- 修复 ComparisonChart 数据处理逻辑
- 从 cycle_number 切换到时间戳分组
- 解决后端重启时图表冻结问题
- 改进图表数据显示(按时间顺序显示所有历史数据)
- 增强调试日志
---
## [2.0.0] - 2025-10-28
### 新增 - 重大更新
- AI 自学习机制(历史反馈、性能分析)
- 多交易员竞赛模式Qwen vs DeepSeek
- 币安风格 UI完整界面仿制
- 性能比较图表(实时 ROI 比较)
- 风险控制优化(每币种仓位限制调整)
### 修复
- 修复硬编码初始余额问题
- 修复多交易员数据同步问题
- 优化图表数据对齐(使用 cycle_number
---
## [1.0.0] - 2025-10-27
### 新增 - 初始版本
- 基础 AI 交易功能
- 决策日志系统
- 简单的 Web 界面
- 支持币安合约
- DeepSeek 和 Qwen AI 模型集成
---
## 如何使用本更新日志
### 用户
- 查看 [未发布] 部分了解即将推出的功能
- 查看版本部分了解变更内容
- 遵循破坏性变更的迁移指南
### 贡献者
进行更改时,将它们添加到 [未发布] 部分的相应类别下:
- **新增** - 新功能
- **变更** - 现有功能的变更
- **弃用** - 即将删除的功能
- **移除** - 已删除的功能
- **修复** - 错误修复
- **安全** - 安全修复
发布新版本时,将 [未发布] 项目移动到带日期的新版本部分。
---
## 链接
- [文档](docs/README.md)
- [贡献指南](CONTRIBUTING.md)
- [安全策略](SECURITY.md)
- [GitHub 仓库](https://github.com/tinkle-community/nofx)
---
**最后更新:** 2025-11-01