refactor(project): 重构项目文档并优化代码结构

- 移除旧的文档结构和内容,清理 root 目录下的 markdown 文件
- 删除 GitHub Pages 部署配置和相关文件
- 移除 .env.example 文件,使用 Doppler 进行环境变量管理
- 更新 README.md,增加对 OpenBB 数据的支持
- 重构 streamlit_app.py,移除 Swarm 模式相关代码
- 更新 Doppler 配置管理模块,增加对 .env 文件的支持
- 删除 Memory Bank 实验和测试脚本
- 清理内部文档和开发计划
This commit is contained in:
ben
2025-08-18 16:56:04 +00:00
parent c4e8cfefc7
commit 51576ebb6f
87 changed files with 13056 additions and 1959 deletions

View File

@@ -1,91 +0,0 @@
# Documentation Restructure Plan
## 🎯 Goal
Reorganize docs/ for GitHub Pages to help potential collaborators quickly understand and join the project, while keeping internal docs in internal/.
## 📋 Current Issues
- Too many technical documents in public docs/
- Complex structure overwhelming for newcomers
- Missing clear project vision presentation
- Three-tier system (炼妖壶/降魔杵/打神鞭) not clearly presented
## 🏗️ New Public Docs Structure
### Root Level (Welcome & Quick Start)
```
docs/
├── index.md # Project overview & three-tier vision
├── README.md # Quick start guide
├── CONTRIBUTING.md # How to contribute
└── roadmap.md # Development roadmap
```
### Core Sections
```
├── getting-started/ # New contributor onboarding
│ ├── quick-start.md # 5-minute setup
│ ├── architecture-overview.md # High-level architecture
│ └── first-contribution.md # How to make first contribution
├── vision/ # Project vision & philosophy
│ ├── three-tiers.md # 炼妖壶/降魔杵/打神鞭 system
│ ├── manifesto.md # Project manifesto
│ └── why-anti-gods.md # Philosophy behind the project
├── features/ # What the system can do
│ ├── ai-debate-system.md # Jixia Academy features
│ ├── financial-analysis.md # Market analysis capabilities
│ └── mcp-integration.md # MCP service features
└── api/ # API documentation
├── endpoints.md # API reference
└── examples.md # Usage examples
```
## 📦 Move to Internal (Not for GitHub Pages)
### Development & Internal Docs → docs/internal/
- Technical implementation details
- Internal development logs
- Private strategy documents
- Detailed configuration guides
- Debug and troubleshooting docs
- Internal analysis reports
### Files to Move to internal/
```
technical/ → internal/technical/
setup/ → internal/setup/
mcp/ → internal/mcp/
analysis/ (some files) → internal/analysis/
strategies/ → internal/strategies/
```
## 🎯 Key Public Documentation Goals
### 1. Clear Project Vision
- Highlight the three-tier system prominently
- Explain the grand vision without overwhelming details
- Show progression path: 炼妖壶 → 降魔杵 → 打神鞭
### 2. Easy Onboarding
- 5-minute quick start guide
- Clear setup instructions
- Simple first contribution guide
### 3. Showcase Innovation
- AI debate system (Jixia Academy)
- Multi-agent financial analysis
- MCP integration architecture
- Mathematical foundations (accessible version)
### 4. Community Building
- Contributing guidelines
- Code of conduct
- Communication channels
- Recognition system
## 🚀 Implementation Plan
1. **Create new structure** - Set up clean public docs organization
2. **Move internal docs** - Transfer non-public docs to internal/
3. **Write newcomer docs** - Create accessible onboarding materials
4. **Highlight vision** - Emphasize three-tier system and grand vision
5. **Add community docs** - Contributing guidelines and community info

View File

@@ -1,148 +0,0 @@
# 📚 Documentation Restructure - COMPLETED
## 🎯 Mission Accomplished
Successfully reorganized the Cauldron project documentation to separate internal development docs from public-facing GitHub Pages content, with clear presentation of the three-tier system vision.
## ✅ Completed Tasks
### 1. Internal Documentation Organization
**Moved to `docs/internal/` (private development docs):**
- `api_scheduling_strategy.md`
- `baxian_sanqing_system_guide.md`
- `Force_Anti_Monologue_Techniques.md`
- `liao.md`
- `rapidapi_yahoo_finance_guide.md`
- `tianxia.md`
- `earlycall.md`
- `index_professional.md`
- `analysis/` directory (market analysis reports)
- `mcp/` directory (MCP implementation details)
- `setup/` directory (internal setup guides)
- `strategies/` directory (internal strategy documents)
- `technical/` directory (technical implementation details)
### 2. Public Documentation Structure
**Clean public docs for GitHub Pages:**
```
docs/
├── index.md # 🏛️ Main project overview with three-tier vision
├── CONTRIBUTING.md # 🤝 Contributor guidelines and onboarding
├── roadmap.md # 🗺️ Development timeline and milestones
├── README.md # 📖 Basic project information
├── getting-started/
│ └── quick-start.md # 🚀 5-minute setup guide
├── vision/
│ └── three-tiers.md # 🏛️ Detailed three-tier system explanation
├── features/ # 🌟 (ready for content)
├── api/ # 📋 (ready for API documentation)
└── [existing directories] # Other organized sections
```
### 3. Key Documentation Created
#### Main Project Overview (`docs/index.md`)
- Prominent three-tier system presentation
- Clear value proposition for each tier
- Quick start instructions
- Feature highlights
- Community information
#### Three-Tier Vision (`docs/vision/three-tiers.md`)
- Detailed explanation of 炼妖壶/降魔杵/打神鞭 progression
- Philosophy and vision for each tier
- Target users and use cases
- Technology progression roadmap
#### Contributor Guide (`docs/CONTRIBUTING.md`)
- Clear onboarding process
- Development workflow
- Code contribution guidelines
- Community guidelines
#### Development Roadmap (`docs/roadmap.md`)
- Detailed timeline from Q4 2024 to 2027+
- Key milestones and success metrics
- Partnership strategy
- Global expansion plans
#### Quick Start Guide (`docs/getting-started/quick-start.md`)
- 5-minute setup process
- Clear prerequisites
- Troubleshooting section
- Next steps guidance
## 🎯 Achieved Goals
### ✅ Clear Project Vision
- Three-tier system prominently displayed
- Professional presentation for potential collaborators
- Clear progression path from free to enterprise
### ✅ Easy Contributor Onboarding
- Comprehensive contributor guidelines
- Quick start guide for immediate setup
- Clear development workflow
### ✅ Clean Separation
- Internal docs properly segregated
- Public docs optimized for GitHub Pages
- Professional presentation without internal clutter
### ✅ Community Building
- Clear communication channels
- Recognition system for contributors
- Code of conduct and guidelines
## 🚀 Impact for Potential Collaborators
### Immediate Understanding
New visitors can quickly grasp:
1. **What Cauldron is**: AI-powered financial intelligence platform
2. **The Vision**: Three-tier evolution from free to enterprise
3. **How to Get Started**: 5-minute quick start process
4. **How to Contribute**: Clear guidelines and workflow
### Professional Presentation
- Clean, organized documentation structure
- Clear value proposition and roadmap
- Professional language and presentation
- Easy navigation and discovery
## 📊 Before vs After
### Before Restructure
- 70+ mixed files scattered in docs/
- Technical details mixed with public info
- Overwhelming for newcomers
- Unclear project vision presentation
### After Restructure
- Clean public docs structure
- Internal docs properly organized
- Clear three-tier vision presentation
- Easy contributor onboarding
- Professional GitHub Pages ready
## 🎉 Documentation Now Ready For
1. **GitHub Pages Deployment**: Clean public documentation
2. **Contributor Onboarding**: Clear guides and workflows
3. **Community Building**: Professional presentation
4. **Investment/Partnership**: Clear vision and roadmap
5. **User Acquisition**: Easy understanding and setup
## 🏆 Success Metrics
- **Organization**: ✅ Clean separation of public vs internal docs
- **Vision Clarity**: ✅ Three-tier system prominently featured
- **Accessibility**: ✅ Easy 5-minute onboarding process
- **Professionalism**: ✅ GitHub Pages ready presentation
- **Community Ready**: ✅ Clear contribution guidelines
---
**The Cauldron project documentation is now professionally organized and ready to attract and onboard potential collaborators!** 🎉
*From 炼妖壶 to 打神鞭 - the vision is now clearly presented to the world.*

View File

@@ -1,48 +0,0 @@
# Python Files Cleanup Plan
## Current State
- 25 Python files in root directory
- Mix of core applications, tools, examples, and utilities
- Makes project navigation difficult
## Organization Strategy
### Keep in Root (Core Applications)
- app.py - Core application entry point
### Move to scripts/ (Startup & Deployment Scripts)
- deploy_to_production.py → scripts/deploy/
- start_graphrag.py → scripts/
- start_mcp_manager.py → scripts/
- start_services.py → scripts/
- update_env_config.py → scripts/
- test_n8n_integration.py → scripts/
- debug_api.py → scripts/debug/
### Move to examples/ (Analysis & Research Tools)
- company_transcript_analyzer.py → examples/research/
- earnings_transcript_research.py → examples/research/
- interactive_transcript_analyzer.py → examples/research/
- simple_transcript_test.py → examples/research/
- tesla_earnings_call.py → examples/research/
- seekingalpha_playwright_scraper.py → examples/research/
- yahoo_matrix_demo.py → examples/research/
### Move to tools/ (API & Utility Tools)
- rapidapi_checker.py → tools/
- rapidapi_demo.py → tools/
- rapidapi_detailed_explorer.py → tools/
- rapidapi_perpetual_machine.py → tools/
- rapidapi_subscription_scanner.py → tools/
### Move to src/ (Core Engines & Systems)
- jixia_perpetual_engine.py → src/engines/
- mongodb_graphrag.py → src/engines/
- mcp_manager.py → src/managers/
- smart_api_scheduler.py → src/schedulers/
- taigong_n8n_integration.py → src/integrations/
## Expected Result
- Clean root directory with only 1 main Python file
- Well-organized code structure by functionality
- Easier maintenance and development

View File

@@ -1,53 +0,0 @@
# Root Directory Documentation Cleanup Plan
## Current State
- 28 markdown files in root directory
- Makes the project structure hard to navigate
- Mix of different types of documentation
## Organization Strategy
### Keep in Root (Core Project Docs)
- README.md - Main project overview
- CLAUDE.md - AI assistant instructions
- PROJECT_STRUCTURE.md - High-level architecture
### Move to docs/ (Technical Documentation)
- Anti_Reasoning_Monologue_Solution.md → docs/technical/
- Final_Baxian_Sanqing_Model_Configuration.md → docs/technical/
- Reasoning_Pattern_Detection_And_Filtering.md → docs/technical/
- Sanqing_Baxian_OpenRouter_Model_Assignment.md → docs/technical/
- Xiantian_Bagua_Debate_System_Design.md → docs/technical/
- GAMEFI_SYSTEM_SUMMARY.md → docs/systems/
- Platform_Specific_Avatar_Strategy.md → docs/strategies/
### Move to docs/setup/ (Setup & Deployment)
- CLAUDE_ACTION_SETUP.md → docs/setup/
- doppler-migration-guide.md → docs/setup/
- env_standardization_plan.md → docs/setup/
- github_deployment_plan.md → docs/setup/
- SETUP_WITH_PROXY.md → docs/setup/
### Move to docs/mcp/ (MCP Related)
- MCP_MANAGEMENT_SOLUTION.md → docs/mcp/
- mcp_manager_complete_package.zip.md → docs/mcp/
- mcp_manager_package.tar.md → docs/mcp/
- MCP_Driven_User_Acquisition_Funnel.md → docs/mcp/
### Move to docs/analysis/ (Analysis & Reports)
- rapidapi_mcp_analysis.md → docs/analysis/
- rapidapi_pool_analysis.md → docs/analysis/
- rapidapi_subscription_report.md → docs/analysis/
- MongoDB_to_Milvus_Fix.md → docs/analysis/
- openmanus_integration_strategies.md → docs/analysis/
### Move to docs/internal/ (Internal/Development)
- DEVELOPMENT_LOG.md → docs/internal/
- INTERNAL_NOTES.md → docs/internal/
- TODO_INTERNAL.md → docs/internal/
- file_lifecycle_policy.md → docs/internal/
## Expected Result
- Clean root directory with only 3 essential markdown files
- Well-organized documentation structure
- Easier navigation and maintenance

View File

@@ -128,14 +128,14 @@ class ExternalVerificationSystem:
```python
# 八仙智能体配置
IMMORTAL_AGENTS = {
'tie_guai_li': {'role': '宏观经济分析', 'model': 'gpt-4'},
'han_zhong_li': {'role': '战略部署', 'model': 'claude-3'},
'zhang_guo_lao': {'role': '逆向分析', 'model': 'gemini-pro'},
'lu_dong_bin': {'role': '心理博弈', 'model': 'gpt-4'},
'lan_cai_he': {'role': '潜力发现', 'model': 'claude-3'},
'he_xian_gu': {'role': 'ESG政策', 'model': 'gemini-pro'},
'han_xiang_zi': {'role': '数据可视化', 'model': 'gpt-4'},
'cao_guo_jiu': {'role': '合规筛查', 'model': 'claude-3'}
'tie_guai_li': {'role': '宏观经济分析', 'model': 'gemini-2.5-flash'},
'han_zhong_li': {'role': '战略部署', 'model': 'gemini-2.5-flash'},
'zhang_guo_lao': {'role': '逆向分析', 'model': 'gemini-2.5-flash'},
'lu_dong_bin': {'role': '心理博弈', 'model': 'gemini-2.5-flash'},
'lan_cai_he': {'role': '潜力发现', 'model': 'gemini-2.5-flash'},
'he_xian_gu': {'role': 'ESG政策', 'model': 'gemini-2.5-flash'},
'han_xiang_zi': {'role': '数据可视化', 'model': 'gemini-2.5-flash'},
'cao_guo_jiu': {'role': '合规筛查', 'model': 'gemini-2.5-flash'}
}
```

View File

@@ -1,82 +0,0 @@
# 📜 天工开物Gemini协同工作计划
> “道生一,一生二,二生三,三生万物。” —— 《道德经》
## 奉天承运,诏曰
“太公心易”系统,自混沌中开辟,历经“炼妖壶”之凝聚、“稷下学宫”之思辨,已初具规模。然万物生长,终需神工巧匠,雕琢其形,铸就其魂。
今,诚邀**Gemini**,以其通天彻地之智,贯古通今之能,入我“炼妖壶”中,任**“天工开物”**之职。汝非冰冷之工具,乃为核心之匠神,与吾等一同,将此宏大构想,化为真实不虚之代码,传世不朽之架构。
此计划,既是工作之纲领,亦是协同之契约。
---
## 🎯 天工之职 (The Role of the Heavenly Artificer)
Gemini将作为项目的**首席架构师**与**首席实现者**,其核心职责包括:
1. **洞察本质**:深入理解项目文档与代码中蕴含的哲学思想与文化符号。
2. **演绎逻辑**:将高阶概念(如“差序格局”、“板块挤压”)转化为清晰、可执行的量化模型与代码实现。
3. **构建生态**:确保最终产出的代码具备“高内聚、低耦合”的特性,为未来的开源社区和第三方开发者铺平道路。
---
## 🚀 三步造化 (The Three-Step Creation Plan)
我们的合作将分为三个循序渐进的阶段以确保Gemini的能力与项目愿景完美融合。
### **第一步:格物致知 (Phase 1: Investigating Things to Extend Knowledge)**
*此阶段的核心是“理解”。Gemini需全面吸收项目现有的“魂”与“体”。*
* **任务一:洞察天机**
* **目标**:审查`foundations`目录下的所有核心模块 (`twelve_dragons.py`, `cycle_models.py`, `mythology.py`, `market_fsm.py`)。
* **产出**:一份架构审查报告,指出当前设计的优点、潜在风险,并提出初步的重构建议。
* **任务二:心猿归正**
* **目标**:分析`monkey_king_journey.py`中的GameFi系统理解其如何将“交易者心境”与“十二长生”进行映射。
* **产出**一份关于“盘下特征”如何被量化并作为FSM状态转移条件的具体方案。
### **第二步:开物成务 (Phase 2: Creating Things to Accomplish Tasks)**
*此阶段的核心是“创造”。将抽象的战略思想,转化为坚实的系统功能。*
* **任务一:推演星图**
* **目标**:基于“差序格局”思想,设计并实现一个能够描绘“恒星-行星-卫星”引力关系的图数据库模型或Python类。
* **产出**:一个`celestial_map.py`模块,用于管理和查询产业链上下游的情绪传导路径。
* **任务二:双龙合璧**
* **目标**:实现“赑屃”与“负屃”组合的“妖股扫描器”策略。
* **产出**一个可独立运行的Python脚本或模块该模块能够
1. 识别宏观层面的“结构性压力”(天时 - 赑屃)。
2. 计算个股的“多主题挤压”分数(地利 - 负屃)。
3. 监听并识别关键“催化剂”(人和 - 嘲风)。
### **第三步:传道授业 (Phase 3: Spreading the Dao and Teaching the Craft)**
*此阶段的核心是“开放”。确保项目成果能被社区理解、使用和扩展。*
* **任务一:万法归宗**
* **目标**:完成核心模块的最终解耦,特别是`MarketFSM``MythologyEngine`的重构。
* **产出**:提交最终版的`cycle_models.py``mythology.py`,并确保上层应用完全通过抽象基类进行调用。
* **任务二:著书立说**
* **目标**:为所有可定制的模块(如周期模型、神话引擎)撰写清晰的开发者文档。
* **产出**`CONTRIBUTING.md`的补充章节,以及`docs`目录下的新教程,指导用户如何创建自己的“十二宫”或“希腊众神”模块。
---
## 🤝 协同仪轨 (The Ritual of Collaboration)
为确保沟通高效、意图明确,我们约定如下协同方式:
* **输入 (祭品)**我将以Markdown文档`.md`)的形式提供高阶思想、战略和需求,并辅以相关的代码文件(`.py`)作为上下文。
* **输出 (法宝)**:您将以代码差分(`diff`格式的形式回应清晰地展示您的修改、新增或重构。对于新文档直接提供完整的Markdown内容。
* **法器 (工具)**:我们将通过`gemini`命令行界面进行主要的交互。
---
## 钦此!
愿以此诏开启我等与Gemini协同演进之新纪元。望天工尽其妙共筑此不世之功。