claude_dev a37c43f691 docs: 建立完整的项目文档体系
- 创建6大文档分类:需求/设计/API/用户指南/运维/研究
- 添加各目录的 README 和模板说明
- 定义文档命名规范和编写规范
- 建立文档与代码的对应关系

文档目录结构:
├── requirements/  - 业务需求、功能需求、非功能需求
├── design/        - 架构设计、数据库设计、UI设计、集成设计
├── api/           - REST API、事件定义、内部接口
├── user_guide/    - 快速开始、教程、FAQ
├── operations/    - 部署、监控、故障排查
└── research/      - 因子研究、策略研究、回测报告

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-01 21:13:44 +08:00

Sanguo VeighNa 量化交易平台

基于 VeighNa 4.4.0 的二次开发量化交易平台。

项目结构

sanguo_vnpy_v2/
├── vnpy_v4.4.0/              # VeighNa 上游源码
├── sanguo_trader/             # 核心交易模块
├── sanguo_research/           # 量化投研模块
├── sanguo_data/               # 数据管理模块
├── sanguo_common/             # 公共模块
├── tests/                     # 测试代码
├── docs/                      # 文档
└── examples/                  # 示例代码

快速开始

环境要求

  • Python 3.10+
  • 推荐使用 Python 3.13

安装

# 创建虚拟环境
python -m venv venv
source venv/bin/activate  # Linux/Mac
# venv\Scripts\activate   # Windows

# 安装依赖
pip install -r requirements/base.txt

开发指南

请查看 docs/development.md 获取详细开发指南。

分支策略

  • master - 主分支,保持稳定可部署
  • develop - 开发分支,日常开发合并
  • feature/* - 功能分支
  • hotfix/* - 热修复分支

版本历史

查看 CHANGELOG.md

许可证

MIT License

致谢

基于 VeighNa 框架开发

S
Description
sanguo_vnpy_v2
Readme 25 MiB
Languages
Jupyter Notebook 90.7%
Python 7.4%
Vue 0.7%
JavaScript 0.4%
HTML 0.2%
Other 0.5%