docs: consolidate CLI documentation and purge legacy structure
MERGE OPERATIONS: - Merged /opt/aitbc/cli/docs into /opt/aitbc/docs/cli - Eliminated duplicate CLI documentation locations - Created single source of truth for CLI docs ORGANIZATION IMPROVEMENTS: - Created structured subdirectories: • implementation/ - Core implementation summaries • analysis/ - Analysis reports and integration summaries • guides/ - Installation and setup guides • legacy/ - Historical documentation (archived) - Updated main README.md with: • New consolidated structure overview • Updated installation instructions for flat CLI structure • Recent CLI design principles changes • Proper navigation to subdirectories - Created legacy/README.md with: • Clear deprecation notice • File categorization • Purge candidates identification • Migration notes from old to new structure FILE MOVES: - 15 implementation summaries → implementation/ - 5 analysis reports → analysis/ - 3 setup guides → guides/ - 19 legacy documented files → legacy/ - 1 demonstration file → root (active reference) PROJECT DOCUMENTATION UPDATES: - Updated /docs/beginner/02_project/1_files.md - Reflected flattened CLI structure (cli/commands/ vs cli/aitbc_cli/commands/) - Added docs/cli/ as consolidated documentation location - Updated Python version requirement to 3.13.5 only BENEFITS: - Single location for all CLI documentation - Clear separation of current vs legacy information - Better organization and discoverability - Easier maintenance and updates - Proper archival of historical documentation STATUS: ✅ Consolidation complete ✅ Legacy properly archived ✅ Structure organized ✅ Documentation updated
This commit is contained in:
76
docs/cli/legacy/README.md
Normal file
76
docs/cli/legacy/README.md
Normal file
@@ -0,0 +1,76 @@
|
||||
# Legacy Documentation
|
||||
|
||||
**Status**: Archived - For Reference Only
|
||||
**Last Updated**: Various dates (mostly March 2026)
|
||||
**Purpose**: Historical documentation from previous development phases
|
||||
|
||||
## ⚠️ Important Notice
|
||||
|
||||
This documentation contains **outdated information** and may reference:
|
||||
- Old CLI structures (before flattening)
|
||||
- Removed features (embedded servers, blocking loops)
|
||||
- Deprecated commands
|
||||
- Previous implementation approaches
|
||||
|
||||
**For current documentation, see the parent directory.**
|
||||
|
||||
---
|
||||
|
||||
## 📂 Legacy Files
|
||||
|
||||
### Phase Documentation (March 2026)
|
||||
- `Phase_1_Multi-Chain_Enhancement_Completion.md`
|
||||
- `Phase_2_Multi-Chain_Enhancement_Completion.md`
|
||||
- `Phase_3_Multi-Chain_Enhancement_Completion.md`
|
||||
|
||||
### Issue Tracking
|
||||
- `Current_Issues_-_Phase_8__Global_AI_Power_Marketpl.md`
|
||||
- `Current_Issues_Update_-_Exchange_Infrastructure_Ga.md`
|
||||
- `Complete_Multi-Chain_Fixes_Needed_Analysis.md`
|
||||
|
||||
### Technical Analysis
|
||||
- `documented_Advanced_Analytics_Platform_-_Technical_Implementa.md`
|
||||
- `documented_Production_Monitoring___Observability_-_Technical_.md`
|
||||
- `documented_Real_Exchange_Integration_-_Technical_Implementati.md`
|
||||
- `documented_Trading_Surveillance_System_-_Technical_Implementa.md`
|
||||
|
||||
### Implementation Status
|
||||
- `documented_Backend_Implementation_Status_-_March_5__2026.md`
|
||||
- `documented_AITBC_Exchange_Infrastructure___Market_Ecosystem_I.md`
|
||||
|
||||
### Quick Fixes & Updates
|
||||
- `documented_CLI_Command_Fixes_Summary_-_March_5__2026.md`
|
||||
- `documented_API_Endpoint_Fixes_Summary.md`
|
||||
- `documented_Nginx_Configuration_Update_Summary_-_March_5__2026.md`
|
||||
- `documented_CLI_Help_Availability_Update_Summary.md`
|
||||
- `documented_CLI_Test_Execution_Results_-_March_5__2026.md`
|
||||
- `documented_Blockchain_Balance_Multi-Chain_Enhancement.md`
|
||||
|
||||
### Checklists & Reference
|
||||
- `documented_AITBC_CLI_Command_Checklist.md`
|
||||
|
||||
---
|
||||
|
||||
## 🗑️ Purge Candidates
|
||||
|
||||
The following files are likely candidates for removal in future cleanup:
|
||||
|
||||
- **Phase completion files** - Historical milestones completed
|
||||
- **Issue tracking files** - Issues likely resolved in current implementation
|
||||
- **Quick fix summaries** - Temporary fixes now integrated
|
||||
- **Old implementation analysis** - Superseded by current implementation
|
||||
|
||||
---
|
||||
|
||||
## 🔍 Migration Notes
|
||||
|
||||
Key changes from legacy to current implementation:
|
||||
|
||||
1. **CLI Structure**: Flattened from `cli/aitbc_cli/` to `cli/`
|
||||
2. **Design Principles**: Removed embedded servers, blocking loops, system calls
|
||||
3. **Dependencies**: Simplified from async pools to basic HTTP clients
|
||||
4. **Documentation**: Consolidated and organized by category
|
||||
|
||||
---
|
||||
|
||||
*This folder is maintained for historical reference only. Current development documentation is in the parent directories.*
|
||||
Reference in New Issue
Block a user