ben/liurenchaxin
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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

Browse Source 
- 移除旧的文档结构和内容，清理 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
Download Patch File Download Diff File Expand all files Collapse all files

91
internal/archive/deprecated_plans/docs_restructure_plan.md
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

148
internal/archive/deprecated_plans/documentation_restructure_completion.md
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.*

48
internal/archive/deprecated_plans/python_files_cleanup_plan.md
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

53
internal/archive/deprecated_plans/root_docs_cleanup_plan.md
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