liurenchaxin/docs/openbb_integration/00_PROJECT_OVERVIEW.md

38 lines
1.7 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# OpenBB 集成项目总览
本目录构建了本项目中 OpenBB v4 集成的完整文档生态,包括架构、实现、测试、用户指南、文化融合与维护。
## 目标
- 以 OpenBB v4 作为统一市场数据路由入口(`from openbb import obb`
- 在未安装或不可用时,提供稳健的兜底策略(演示/合成数据)
- 将集成能力与稷下学宫/八仙论道的产品体验深度融合
## 核心组件
- UI`app/tabs/openbb_tab.py`(自动检测 OpenBB 可用性,提供回退)
- 引擎:`src/jixia/engines/openbb_engine.py`、`src/jixia/engines/openbb_stock_data.py`
- 示例/演示数据:`examples/data/*.json`
## 用户旅程(摘要)
```mermaid
graph TD
A[用户启动应用] --> B[选择OpenBB标签页]
B --> C[查看数据可用性状态]
C --> D{OpenBB是否可用?}
D -->|是| E[选择股票符号]
D -->|否| F[使用演示数据]
E --> G[启动八仙论道]
F --> G
G --> H[查看辩论结果]
H --> I[导出分析报告]
```
## 快速链接
- 实现指南API 集成与回退策略):[02_IMPLEMENTATION_GUIDE/api_integration_guide.md](../openbb_integration/02_IMPLEMENTATION_GUIDE/api_integration_guide.md)
- 故障排查:[02_IMPLEMENTATION_GUIDE/troubleshooting_guide.md](../openbb_integration/02_IMPLEMENTATION_GUIDE/troubleshooting_guide.md)
- 测试策略与报告:[03_TEST_DOCUMENTATION/](../openbb_integration/03_TEST_DOCUMENTATION/)
- 用户指南:[04_USER_GUIDES/](../openbb_integration/04_USER_GUIDES/)
## 维护与路线图
- 版本说明与升级:见 [06_MAINTENANCE](../openbb_integration/06_MAINTENANCE/)
> 注:本结构与 docs/AI_AGENT_TASKS/ROVODEV_PROJECT_INTEGRATION.md 的“文档架构”保持一致,以便多团队协作与交付。