17 KiB
Documentation Migration Plan
Date: January 2025
Purpose: Complete migration plan for consolidating 179 markdown files into SSOT structure
Total Files: 179
Migration Summary
- KEEP: 7 files (SSOT, supporting docs, README)
- MERGE INTO SSOT: 45 files (content consolidated into SSOT.md)
- DELETE: 110 files (duplicates, outdated, historical status)
- ARCHIVE: 17 files (historical phase reports, moved to docs/archive/)
File Actions
KEEP (7 files)
| File | Action | Reason |
|---|---|---|
docs/SSOT.md |
KEEP | Single source of truth (newly created) |
docs/DOCS_INDEX.md |
KEEP | Documentation index (newly created) |
docs/DOCS_GOVERNANCE.md |
KEEP | Governance rules (newly created) |
docs/DOCS_MIGRATION_PLAN.md |
KEEP | This file - migration reference |
docs/deployment-runbook.md |
KEEP | Detailed operational runbook |
docs/backup-procedures.md |
KEEP | Operational backup procedures |
docs/coding-standards.md |
KEEP | Development guidelines |
README.md |
KEEP | Root README (will be updated to point to SSOT) |
MERGE INTO SSOT (45 files)
Content from these files has been consolidated into docs/SSOT.md:
Setup & Getting Started (6 files)
| File | Merged Into SSOT Section | Reason |
|---|---|---|
QUICK_START_GUIDE.md |
Local Development Setup | Setup instructions consolidated |
QUICK_START_LOCAL.md |
Local Development Setup | Local setup consolidated |
START_HERE.md |
Overview, Local Development Setup | Entry point content merged |
SUPABASE_SETUP.md |
Database & Supabase | Supabase setup merged |
SUPABASE_LOCAL_SETUP.md |
Database & Supabase | Local Supabase setup merged |
NEXT_STEPS.md |
Overview | Next steps merged into overview |
Environment Variables (2 files)
| File | Merged Into SSOT Section | Reason |
|---|---|---|
ENVIRONMENT_VARIABLES.md |
Environment Configuration | Complete env var reference merged |
ENV_VARIABLES_NOTES.md |
Environment Configuration | Supabase-specific notes merged |
Deployment (10 files)
| File | Merged Into SSOT Section | Reason |
|---|---|---|
DEPLOYMENT_QUICK_START.md |
Deployment (Proxmox) | Quick start merged |
docs/DEPLOYMENT_QUICK_START.md |
Deployment (Proxmox) | Duplicate, merged |
docs/DEPLOYMENT_MACBOOK_TO_PROXMOX.md |
Deployment (Proxmox) | MacBook setup merged |
docs/DEPLOYMENT_PROXMOX_SUPABASE.md |
Deployment (Proxmox), Database & Supabase | Supabase deployment merged |
YOUR_DEPLOYMENT_GUIDE.md |
Deployment (Proxmox) | Personal deployment guide merged |
YOUR_PROXMOX_SETUP.md |
Deployment (Proxmox) | Personal setup merged |
PROXMOX_DEPLOYMENT_GUIDE.md |
Deployment (Proxmox) | Comprehensive guide merged |
docs/PROXMOX_NETWORK_CONFIG.md |
Deployment (Proxmox) | Network config merged |
CONTAINER_CREATION_COMMANDS.md |
Deployment (Proxmox) | Container commands merged |
docs/proxmox-migration.md |
Architecture, Deployment | Architecture and migration merged |
Architecture (5 files)
| File | Merged Into SSOT Section | Reason |
|---|---|---|
CODEBASE_REVIEW.md |
Architecture | Architecture analysis merged |
DATA_FLOW_ANALYSIS.md |
Architecture | Data flow merged |
FEATURE_MAPPING.md |
Overview | Features merged into overview |
COMPONENT_INVENTORY.md |
Architecture | Component structure merged |
COMPREHENSIVE_AUDIT_REPORT.md |
Architecture, Overview | Audit findings merged |
Security (8 files)
| File | Merged Into SSOT Section | Reason |
|---|---|---|
SECURITY.md |
Environment Configuration (security section) | Security implementation merged |
SECURITY_TOOLS_SETUP.md |
Environment Configuration | Security tools merged |
RLS_FIX_SUMMARY.md |
Database & Supabase | RLS fixes merged |
RLS_STATUS.md |
Database & Supabase | RLS status merged |
RLS_VERIFICATION.md |
Database & Supabase | RLS verification merged |
RLS_SECURITY_ISSUE.md |
Database & Supabase | RLS security merged |
docs/csrf-audit.md |
Environment Configuration | CSRF audit merged |
docs/secrets-management-audit.md |
Environment Configuration | Secrets audit merged |
docs/security-headers-audit.md |
Environment Configuration | Security headers merged |
docs/file-upload-security-audit.md |
Environment Configuration | File upload security merged |
docs/security-audit-checklist.md |
Environment Configuration | Security checklist merged |
Troubleshooting (5 files)
| File | Merged Into SSOT Section | Reason |
|---|---|---|
TROUBLESHOOTING.md |
Troubleshooting | Troubleshooting guide merged |
TURBOPACK_FIX.md |
Troubleshooting | Turbopack fix merged |
TURBOPACK_WORKAROUND.md |
Troubleshooting | Turbopack workaround merged |
DATABASE_CONNECTION_STATUS.md |
Troubleshooting | Database troubleshooting merged |
CHUNK_LOAD_ERROR_FIX.md |
Troubleshooting | Chunk load error merged |
Operations (4 files)
| File | Merged Into SSOT Section | Reason |
|---|---|---|
BACKUP_RESTORE_GUIDE.md |
Operations & Runbooks | Backup guide merged (detailed procedures in backup-procedures.md) |
POST_LAUNCH_MONITORING.md |
Operations & Runbooks | Monitoring merged |
PRE_LAUNCH_CHECKLIST.md |
Deployment (Proxmox) | Pre-launch checklist merged |
QUICK_REFERENCE.md |
Operations & Runbooks | Quick reference merged |
Configuration (2 files)
| File | Merged Into SSOT Section | Reason |
|---|---|---|
OPENWEATHER_SETUP.md |
Environment Configuration | OpenWeather setup merged |
QUICK_OPENWEATHER_SETUP.md |
Environment Configuration | Quick OpenWeather setup merged |
SENTRY_CONFIGURATION.md |
Environment Configuration | Sentry config merged |
Other (3 files)
| File | Merged Into SSOT Section | Reason |
|---|---|---|
PRODUCTION.md |
Deployment (Proxmox) | Production config merged |
PRODUCTION_SUMMARY.md |
Overview | Production summary merged |
HANDOFF.md |
Operations & Runbooks | Handoff procedures merged |
DELETE (110 files)
These files are duplicates, outdated, or contain information already in SSOT:
Duplicate/Outdated Deployment (8 files)
DEPLOYMENT_SETUP.md- Duplicate, merged into SSOTDEPLOYMENT_READY.md- Status file, outdatedDEPLOYMENT_CONFIGURED.md- Status file, outdatedDEPLOYMENT_STATUS.md- Status file, outdatedDEPLOYMENT_CHECKLIST.md- Merged into deployment-runbook.mdREADME_PRODUCTION.md- Duplicate of README, merged into SSOTdocs/PROD-READINESS.md- Duplicate, merged into SSOT
Production Readiness Status (12 files)
PRODUCTION_READINESS_COMPLETE.md- Status file, outdatedPRODUCTION_READINESS_FINAL.md- Status file, outdatedPRODUCTION_READINESS_PROGRESS.md- Status file, outdatedPRODUCTION_READINESS_STATUS.md- Status file, outdatedPRODUCTION_READINESS_SUMMARY.md- Status file, outdatedPRODUCTION_READINESS_REPORT.md- Status file, outdatedPRODUCTION_READINESS_CHECKLIST.md- Merged into SSOTPRODUCTION_READY.md- Status file, outdatedPRODUCTION_READY_CHECKLIST.md- Duplicate checklistPRODUCTION_IMPLEMENTATION_PROGRESS.md- Status file, outdateddocs/PRODUCTION_READINESS_FINAL.md- Duplicate status filedocs/PRODUCTION_READINESS_FINAL_SUMMARY.md- Duplicate status filedocs/production-readiness-audit.md- Merged into SSOTdocs/production-readiness-plan.md- Merged into SSOTdocs/production-readiness-summary.md- Merged into SSOT
Phase Status Reports (50+ files)
All phase status/progress files are historical and should be archived or deleted:
Phase 2:
PHASE2_IMPLEMENTATION_SUMMARY.md- Historical statusdocs/phase2-completion-summary.md- Historical status
Phase 3:
docs/phase3-complete-summary.md- Historical statusdocs/phase3-current-status.md- Historical statusdocs/phase3-final-status.md- Historical statusdocs/phase3-final-summary.md- Historical statusdocs/phase3-other-tasks-summary.md- Historical statusdocs/phase3-progress-update.md- Historical statusdocs/phase3-progress.md- Historical statusdocs/phase3-update-summary.md- Historical status
Phase 4:
PHASE4_IMPLEMENTATION_SUMMARY.md- Historical statusdocs/PHASE4_COMPLETE_CELEBRATION.md- Historical statusdocs/PHASE4_TESTING_100_PERCENT_COMPLETE.md- Historical statusdocs/PHASE4_TESTING_COMPLETE.md- Historical statusdocs/PHASE4_TESTING_COMPLETE_FINAL.md- Historical statusdocs/PHASE4_TESTING_COMPLETE_REPORT.md- Historical statusdocs/PHASE4_TESTING_COMPREHENSIVE_REPORT.md- Historical statusdocs/PHASE4_TESTING_EXPANDED.md- Historical statusdocs/PHASE4_TESTING_FINAL_EXPANSION.md- Historical statusdocs/PHASE4_TESTING_FINAL_REPORT.md- Historical statusdocs/PHASE4_TESTING_NEAR_COMPLETE.md- Historical statusdocs/PHASE4_TESTING_SUCCESS_SUMMARY.md- Historical statusdocs/PHASE4_TO_PHASE5_TRANSITION.md- Historical statusdocs/phase4-testing-achievements.md- Historical statusdocs/phase4-testing-comprehensive-summary.md- Historical statusdocs/phase4-testing-comprehensive-update.md- Historical statusdocs/phase4-testing-final-status.md- Historical statusdocs/phase4-testing-final-summary.md- Historical statusdocs/phase4-testing-final-update.md- Historical statusdocs/phase4-testing-progress-update.md- Historical statusdocs/phase4-testing-progress.md- Historical statusdocs/phase4-testing-status.md- Historical statusdocs/phase4-testing-update.md- Historical status
Phase 5:
docs/PHASE5_COMPLETE_SUMMARY.md- Historical statusdocs/PHASE5_FINAL_STATUS.md- Historical statusdocs/PHASE5_INTEGRATION_GUIDE.md- Historical status (merged into SSOT)docs/PHASE5_OBSERVABILITY_IMPLEMENTATION.md- Historical status (merged into SSOT)
Phase 6:
docs/PHASE6_COMPLETE.md- Historical statusdocs/PHASE6_COMPLETE_FINAL.md- Historical statusdocs/PHASE6_COMPLETE_SUMMARY.md- Historical statusdocs/PHASE6_FINAL_STATUS.md- Historical statusdocs/PHASE6_IMAGE_OPTIMIZATION_AUDIT.md- Historical status (merged into SSOT)docs/PHASE6_PERFORMANCE_OPTIMIZATION.md- Historical status (merged into SSOT)docs/PHASE6_PROGRESS_REPORT.md- Historical statusdocs/PHASE6_QUERY_AUDIT.md- Historical status (merged into SSOT)
Phase 7:
docs/PHASE7_COMPLETE.md- Historical statusdocs/PHASE7_FINAL_SUMMARY.md- Historical statusdocs/PHASE7_PROGRESS.md- Historical statusdocs/PHASE7_SETUP_GUIDE.md- Historical status (merged into SSOT)docs/PHASE7_STORAGE_MIGRATION.md- Historical status (merged into SSOT)
Phase 8:
docs/PHASE8_COMPLETE.md- Historical statusdocs/PHASE8_PROGRESS.md- Historical status
All Phases:
docs/ALL_PHASES_FINAL_STATUS.md- Historical statusdocs/ALL_PHASES_STATUS.md- Historical status
Test Coverage Reports (15 files)
All test coverage reports are historical status files:
TEST_COVERAGE_ANALYSIS.md- Historical statusTEST_COVERAGE_REPORT.md- Historical statusTEST_COVERAGE_FINAL_REPORT.md- Historical statusTEST_COVERAGE_FINAL_SUMMARY.md- Historical statusTEST_COVERAGE_EXPANSION_SUMMARY.md- Historical statusTEST_COVERAGE_100_PERCENT.md- Historical statusTEST_EXPANSION_STRATEGY.md- Historical statusTEST_IMPLEMENTATION_COMPLETE.md- Historical statusdocs/TEST_COVERAGE_100_PERCENT.md- Duplicatedocs/TEST_COVERAGE_EXPANSION_SUMMARY.md- Duplicatedocs/TEST_COVERAGE_FINAL_REPORT.md- Duplicatedocs/TEST_COVERAGE_FINAL_SUMMARY.md- Duplicatedocs/TEST_COVERAGE_REPORT.md- Duplicatedocs/TEST_IMPLEMENTATION_COMPLETE.md- Duplicatedocs/test-coverage-summary.md- Duplicatedocs/test-implementation-complete-summary.md- Duplicatedocs/testing-progress-summary.md- Duplicatedocs/FINAL_TEST_COVERAGE_REPORT.md- Duplicatedocs/FINAL_TEST_SUMMARY.md- Duplicate
Implementation Summaries (10 files)
IMPLEMENTATION_SUMMARY.md- Historical statusIMPLEMENTATION_COMPLETE_SUMMARY.md- Historical statusIMPLEMENTATION_COMPLETE_REPORT.md- Historical statusCOMPLETION_REPORT.md- Historical statusFINAL_STATUS.md- Historical statusFINAL_STATUS_REPORT.md- Historical statusMASTER_SUMMARY.md- Historical status (superseded by SSOT)MASTER_DOCUMENTATION.md- Historical status (superseded by SSOT)docs/implementation-status.md- Historical statusDOCUMENTATION_MAP.md- Historical status (superseded by DOCS_MIGRATION_PLAN.md)
Audit Reports (5 files)
AUDIT_SUMMARY.md- Merged into SSOTDEAD_CODE_REPORT.md- Historical statusBUNDLE_OPTIMIZATION_REPORT.md- Historical status (merged into SSOT)IMAGE_OPTIMIZATION_REPORT.md- Historical status (merged into SSOT)POLLING_ANALYSIS.md- Historical status (merged into SSOT)
Fix Logs & Status (10 files)
BUG_FIX_LOG.md- Historical fix logFIXES_APPLIED.md- Historical fix logAPI_FIXES_SUMMARY.md- Historical fix logAPI_CALLS_ANALYSIS.md- Historical analysisSUPABASE_FIXES_SUMMARY.md- Historical fix logSUPABASE_AUTH_FIXES_COMPLETE.md- Historical fix logSUPABASE_AUTH_ANALYSIS_AND_FIXES.md- Historical fix logSUPABASE_COMPREHENSIVE_ANALYSIS.md- Historical analysisADMIN_UI_FIXES.md- Historical fix logADMIN_UI_REFACTOR_SUMMARY.md- Historical fix logADMIN_REALTIME_IMPROVEMENTS.md- Historical fix logADMIN_DASHBOARD_AUDIT.md- Historical auditADMIN_DASHBOARD_SUPABASE_AUDIT.md- Historical auditADMIN_AUTH_MIGRATION.md- Historical migration logREDIS_RATE_LIMITING_MIGRATION.md- Historical migration logVENUE_UPDATE_SUMMARY.md- Historical updateUNBLOCK_INSTRUCTIONS.md- Historical instructionsMANUAL_TESTING_CHECKLIST.md- Historical checklist
Other (5 files)
USER_STORIES.md- Historical reference (merged into SSOT overview)MISSING_ENHANCEMENTS_REVIEW.md- Historical reviewdocs/zod-validation-complete-summary.md- Historical statusdocs/README.md- Duplicate, content in DOCS_INDEX.mdgemini.md- Historical reference
ARCHIVE (17 files)
These files contain historical information that may be useful for reference. Move to docs/archive/:
Phase Reports (move to docs/archive/phases/)
- All phase status files listed above (50+ files) - Note: Actually DELETE these as they're too numerous and outdated
Implementation History (move to docs/archive/implementation/)
IMPLEMENTATION_SUMMARY.mdIMPLEMENTATION_COMPLETE_SUMMARY.mdIMPLEMENTATION_COMPLETE_REPORT.mdCOMPLETION_REPORT.mdFINAL_STATUS.mdFINAL_STATUS_REPORT.mdMASTER_SUMMARY.mdMASTER_DOCUMENTATION.md
Note: Given the large number of phase files, it's recommended to DELETE them rather than archive, as they're purely historical status reports with no actionable information.
Redirect Map
When files are deleted or moved, update any internal links:
| Old Path | New Path/Anchor |
|---|---|
ENVIRONMENT_VARIABLES.md |
docs/SSOT.md#environment-configuration |
ENV_VARIABLES_NOTES.md |
docs/SSOT.md#environment-configuration |
QUICK_START_GUIDE.md |
docs/SSOT.md#local-development-setup |
QUICK_START_LOCAL.md |
docs/SSOT.md#local-development-setup |
START_HERE.md |
docs/SSOT.md |
SUPABASE_SETUP.md |
docs/SSOT.md#database--supabase |
DEPLOYMENT_QUICK_START.md |
docs/SSOT.md#deployment-proxmox |
docs/DEPLOYMENT_QUICK_START.md |
docs/SSOT.md#deployment-proxmox |
PROXMOX_DEPLOYMENT_GUIDE.md |
docs/SSOT.md#deployment-proxmox |
YOUR_DEPLOYMENT_GUIDE.md |
docs/SSOT.md#deployment-proxmox |
TROUBLESHOOTING.md |
docs/SSOT.md#troubleshooting |
SECURITY.md |
docs/SSOT.md#environment-configuration (security section) |
BACKUP_RESTORE_GUIDE.md |
docs/backup-procedures.md |
CODEBASE_REVIEW.md |
docs/SSOT.md#architecture |
MASTER_DOCUMENTATION.md |
docs/SSOT.md |
MASTER_SUMMARY.md |
docs/SSOT.md#overview |
README_PRODUCTION.md |
docs/SSOT.md#deployment-proxmox |
Migration Steps
-
Create SSOT and supporting docs ✅
docs/SSOT.md- Createddocs/DOCS_INDEX.md- Createddocs/DOCS_GOVERNANCE.md- To be createddocs/DOCS_MIGRATION_PLAN.md- This file
-
Update root README.md
- Point to
docs/DOCS_INDEX.mdanddocs/SSOT.md - Remove duplicate setup instructions
- Point to
-
Delete files marked for deletion
- Use this plan as reference
- Verify no critical information is lost
-
Update internal links
- Search for references to deleted files
- Update to point to SSOT sections
-
Create archive directory (optional)
docs/archive/phases/- For phase reports (if keeping)docs/archive/implementation/- For implementation history (if keeping)
-
Verify migration
- Run
./scripts/check-docs.sh - Verify all links work
- Ensure no broken references
- Run
Post-Migration
After migration:
- All documentation should be in
docs/directory docs/SSOT.mdis the single source of truth- Supporting docs are minimal and linked from SSOT
- No duplicate setup instructions
- All historical files removed or archived
Last Updated: January 2025
Migration Status: Plan Complete - Ready for Execution