Commit Graph

3 Commits

Author SHA1 Message Date
liuping 87f942d40c docs: add comprehensive Chinese documentation to version control
� Complete Chinese Documentation Suite:

� New Chinese Documents:
- docs/zh-CN/README.md - 中文版系统概览和快速开始
- docs/zh-CN/architecture_guide.md - 系统架构和技术实现详解
- docs/zh-CN/quick_start_guide.md - 5分钟快速设置和使用教程

� Enhanced Chinese Documents:
- docs/zh-CN/configuration_guide.md - 新功能配置详解
  - 百炼(DashScope)配置
  - 多市场支持配置
  - 数据库集成配置
  - API密钥需求说明

� Updated Main Documentation:
- docs/README.md - 更新版本控制策略,包含中文文档

� Key Features Covered:
- �� 中国A股市场支持 (通达信API)
- � 百炼(DashScope)大模型集成
- �️ 数据库集成 (MongoDB + Redis)
- � 多市场选择和配置
- � 智能缓存和回退机制

� Documentation Structure:
docs/
├── README.md (Updated)
├── en-US/ (English docs)
│   ├── configuration_guide.md
│   ├── architecture_guide.md
│   ├── quick_start_guide.md
│   ├── quick_reference.md
│   └── prompt_templates.md
└── zh-CN/ (Chinese docs)  Now in version control
    ├── README.md (New)
    ├── configuration_guide.md (Enhanced)
    ├── architecture_guide.md (New)
    ├── quick_start_guide.md (New)
    ├── quick_reference.md
    └── prompt_templates.md

� Bilingual Support Benefits:
- Comprehensive coverage for both international and Chinese users
- Localized examples and use cases
- Market-specific configuration guidance
- Cultural and technical context adaptation

Now both English and Chinese users have complete
documentation covering all system features and capabilities.
2025-07-06 02:53:30 +08:00
liuping 2933046060 docs: clarify DashScope API key requirements - only needed for Chinese stocks or Qwen models
� Important Clarification - DashScope API Key Requirements:

� Updated Documentation:
- docs/en-US/quick_start_guide.md
- docs/en-US/configuration_guide.md
- .env.example

� DashScope API Key is ONLY required when:
1. � Analyzing Chinese A-share stocks (uses TongDaXin data + DashScope embeddings)
2. � Choosing DashScope as LLM provider (Qwen models)

 For US Stock Analysis:
- OpenAI + FinnHub:  No DashScope needed
- Google AI + FinnHub:  No DashScope needed
- Anthropic + FinnHub:  No DashScope needed

 DashScope Required Cases:
- China A-Share + Any LLM:  DashScope needed (for embeddings)
- US Stock + DashScope LLM:  DashScope needed (for Qwen models)
- China A-Share + DashScope LLM:  DashScope needed (both reasons)

� Updated Configuration Examples:
- Example 1: US stocks with OpenAI (no DashScope)
- Example 2: US stocks with Google AI (no DashScope)
- Example 3: China A-shares (DashScope required)
- Example 4: US stocks with DashScope LLM (DashScope required)
- Example 5: Full features with database

� Key Benefits:
- Users can start with familiar LLM providers (OpenAI/Google)
- DashScope only needed for Chinese market features
- Clear separation of requirements by use case
- Reduced barrier to entry for US-only users

This clarification makes it easier for users to understand
exactly when they need which API keys based on their
specific use case and market focus.
2025-07-06 02:45:35 +08:00
liuping 0de847601e feat: merge Chinese version features
- Add 18 new feature files from Chinese version
- Support for Chinese market data (A-shares)
- Database integration with MongoDB
- Advanced caching system with adaptive strategies
- LLM adapters for DashScope and other providers
- API services and real-time data utilities
- Enhanced configuration management
- Comprehensive English documentation

New features:
- Chinese finance data aggregation
- TDX (TongDaXin) API integration
- Optimized China stock data provider
- Adaptive and integrated caching
- Database cache management
- Stock data services
- Real-time news utilities

Breaking changes: None (all new features are additive)
Dependencies: Added pymongo, beautifulsoup4, dashscope (optional)

For detailed information, see MERGE_SUMMARY.md
2025-07-06 00:26:49 +08:00