| # π Archived Documentation |
|
|
| **Archive Date:** December 13, 2025 |
| **Total Files:** 73 markdown files |
| **Reason:** Historical documentation cleanup - moved old/duplicate docs to reduce clutter |
|
|
| --- |
|
|
| ## π What's Archived Here |
|
|
| This archive contains **historical documentation** that is no longer actively used but is preserved for reference. All files were safely moved here after a comprehensive audit confirmed they have: |
|
|
| - β
No code dependencies |
| - β
No active references in current documentation |
| - β
No impact on production systems |
| - β
Been superseded by newer documentation |
|
|
| --- |
|
|
| ## π Archive Structure |
|
|
| ### `/persian/` (17 files) |
| Persian language documentation for users who prefer Farsi/Persian. |
|
|
| **Contents:** |
| - Implementation guides (Persian) |
| - Quick start guides (Persian) |
| - Test reports (Persian) |
| - Deployment guides (Persian) |
| - Project completion reports (Persian) |
|
|
| **Note:** Archived because primary documentation is in English. Can be restored if Persian-speaking users need these. |
|
|
| --- |
|
|
| ### `/cursor-instructions/` (7 files) |
| Cursor AI IDE specific instructions and prompts. |
|
|
| **Contents:** |
| - AI developer prompts |
| - HuggingFace deployment requests |
| - Data architecture analysis |
| - Start instructions for AI |
|
|
| **Note:** IDE-specific, not needed for production runtime. |
|
|
| --- |
|
|
| ### `/historical-fixes/` (36 files) |
| Historical fix reports, implementation summaries, and status updates. |
|
|
| **Contents:** |
| - Old bug fix reports (pre-Dec 2025) |
| - System monitor upgrades |
| - Implementation complete summaries |
| - Verification checklists |
| - UI structure guides |
| - Working endpoints (old version) |
| - And many more historical status reports |
|
|
| **Note:** Superseded by current documentation: |
| - `HUGGINGFACE_SPACE_FIXES_COMPLETE.md` (current) |
| - `DEPLOYMENT_CHECKLIST.md` (current) |
| - `README_CRITICAL_FIXES.md` (current) |
|
|
| --- |
|
|
| ### `/old-qa-reports/` (5 files) |
| Historical QA test reports and action checklists. |
|
|
| **Contents:** |
| - Provider rotation tests |
| - Real data validation reports |
| - Mock data removal reports |
| - QA action checklists |
| - QA report from Dec 3, 2025 |
|
|
| **Note:** Historical test documentation. Current testing covered in main docs. |
|
|
| --- |
|
|
| ### `/old-ui-guides/` (6 files) |
| Old UI enhancement guides and fix summaries. |
|
|
| **Contents:** |
| - Error fixes summary |
| - Server fixes guide |
| - Static structure |
| - UI enhancements guide |
| - UI improvements summary |
| - User API guide |
|
|
| **Note:** UI documentation is now in component-specific locations. |
|
|
| --- |
|
|
| ### `/duplicate-docs/` (2 files) |
| Duplicate or redundant documentation. |
|
|
| **Contents:** |
| - Complete API reference (old version) |
| - NewResourceApi upgrade analysis |
|
|
| **Note:** Content covered in current documentation. |
|
|
| --- |
|
|
| ## β
Current Active Documentation |
|
|
| The following documentation **remains active** and should be used: |
|
|
| ### Main Documentation: |
| - `README.md` - Main project documentation |
| - `DELIVERABLES.md` - Project deliverables |
| - `README_DEPLOYMENT.md` - Deployment guide |
| - `QUICK_START.md` - Quick start guide |
|
|
| ### Current Fixes (Dec 13, 2025): |
| - `HUGGINGFACE_SPACE_FIXES_COMPLETE.md` - Comprehensive fix guide |
| - `DEPLOYMENT_CHECKLIST.md` - Deployment testing |
| - `QUICK_START_FIXES.md` - Quick reference |
| - `README_CRITICAL_FIXES.md` - User-facing summary |
|
|
| ### Feature Documentation: |
| - `static/pages/*/README.md` - Feature-specific guides |
| - `collectors/README.md` - Collectors documentation |
| - `api-resources/README.md` - API resources guide |
|
|
| ### Trading Assistant (Active): |
| - `static/pages/trading-assistant/START_HERE.md` |
| - `static/pages/trading-assistant/QUICK_START.md` |
| - `static/pages/trading-assistant/STRATEGIES_README.md` |
| - And other trading-assistant docs (feature is active) |
|
|
| --- |
|
|
| ## π Restoration |
|
|
| If you need to restore any archived file: |
|
|
| ```bash |
| # Restore a specific file |
| cp archive/docs/[category]/[filename].md ./ |
| |
| # Restore entire category |
| cp archive/docs/[category]/*.md ./ |
| |
| # Example: Restore Persian documentation |
| cp archive/docs/persian/*.md ./ |
| ``` |
|
|
| --- |
|
|
| ## β οΈ Important Notes |
|
|
| 1. **No Files Deleted:** All files are preserved, just moved to archive |
| 2. **No Code Impact:** No Python, HTML, or JS files reference these docs |
| 3. **Git History Preserved:** Full git history available for all files |
| 4. **Docker Unaffected:** `.dockerignore` already excluded all .md except README.md |
| 5. **Easy Restoration:** Simply copy files back if needed |
|
|
| --- |
|
|
| ## π Archive Statistics |
|
|
| | Category | Files | Size | |
| |----------|-------|------| |
| | Persian docs | 17 | ~150KB | |
| | Cursor instructions | 7 | ~50KB | |
| | Historical fixes | 36 | ~400KB | |
| | QA reports | 5 | ~40KB | |
| | Old UI guides | 6 | ~50KB | |
| | Duplicate docs | 2 | ~30KB | |
| | **TOTAL** | **73** | **~720KB** | |
|
|
| --- |
|
|
| ## π Audit Report |
|
|
| Full audit report available: `MD_FILES_AUDIT_REPORT.md` (in root directory) |
|
|
| The audit confirmed: |
| - 105 total MD files analyzed |
| - 73 files safely archived (this folder) |
| - 30 files kept active (essential documentation) |
| - 0 code dependencies broken |
| - 0 references broken |
|
|
| --- |
|
|
| ## π
Archive History |
|
|
| - **2025-12-13:** Initial archive created |
| - Moved 73 historical documentation files |
| - Organized by category |
| - All safety checks passed |
| - Git commit: "Archive historical documentation" |
|
|
| --- |
|
|
| ## π Questions? |
|
|
| If you need any of these files or have questions about the archive: |
|
|
| 1. Check the audit report: `MD_FILES_AUDIT_REPORT.md` |
| 2. Review git history: `git log -- archive/docs/` |
| 3. Restore files as needed using commands above |
|
|
| --- |
|
|
| **Archive Maintained By:** Project cleanup automation |
| **Last Updated:** December 13, 2025 |
| **Status:** β
Active Archive |
|
|