From a7fbf5846251466749c0ce4c9635d56d3cbd4de0 Mon Sep 17 00:00:00 2001 From: aitbc Date: Sat, 9 May 2026 21:52:55 +0200 Subject: [PATCH] docs: merge docs/project files into appropriate doc directories - Moved ai-economics/ to docs/ai-economics/ - Moved completion/ to docs/completion/ - Merged cli/ with docs/cli/ - Merged infrastructure/ with docs/infrastructure/ - Moved planning/ to docs/planning/ - Moved requirements/ to docs/requirements/ - Moved workspace/ to docs/development/workspace/ - Moved 1_files.md to docs/reference/REPOSITORY_STRUCTURE.md - Moved 2_roadmap.md to docs/ROADMAP.md - Moved 3_infrastructure.md to docs/infrastructure/INFRASTRUCTURE.md - Moved SECURITY.md to docs/security/SECURITY.md - Moved PROJECT_STRUCTURE.md to docs/archive/GPU_PROJECT_STRUCTURE.md - Moved WORKING_SETUP.md to docs/guides/getting-started/WORKING_SETUP.md - Moved E2E_TEST_CREATION_SUMMARY.md to docs/reports/E2E_TEST_CREATION_SUMMARY.md - Moved SQLMODEL_METADATA_FIX_SUMMARY.md to docs/reports/SQLMODEL_METADATA_FIX_SUMMARY.md - Moved GITHUB_PULL_SUMMARY.md to docs/reports/GITHUB_PULL_SUMMARY.md - Moved GIFT_CERTIFICATE_newuser.md to docs/guides/getting-started/GIFT_CERTIFICATE.md - Moved user_profile_newuser.md to docs/guides/getting-started/USER_PROFILE.md - Moved aitbc.md to docs/infrastructure/NODE_AITBC.md - Moved aitbc1.md to docs/infrastructure/NODE_AITBC1.md - Updated project/README.md with new documentation locations - Removed empty subdirectories from docs/project/ - Created docs/MERGE_PLAN.md for reference --- docs/MERGE_PLAN.md | 103 ++++++++++++++++++ docs/{project/2_roadmap.md => ROADMAP.md} | 0 .../ai-economics/AI_ECONOMICS_MASTERS.md | 0 .../GPU_PROJECT_STRUCTURE.md} | 0 docs/{project => }/cli/CLI_DOCUMENTATION.md | 0 .../completion/PROJECT_COMPLETION_SUMMARY.md | 0 .../workspace/WORKSPACE_STRATEGY.md | 0 .../getting-started/GIFT_CERTIFICATE.md} | 0 .../getting-started/USER_PROFILE.md} | 0 .../getting-started}/WORKING_SETUP.md | 0 .../INFRASTRUCTURE.md} | 0 .../infrastructure/LOGS_ORGANIZATION.md | 0 .../aitbc.md => infrastructure/NODE_AITBC.md} | 0 .../NODE_AITBC1.md} | 0 .../infrastructure/PRODUCTION_ARCHITECTURE.md | 0 .../infrastructure/RUNTIME_DIRECTORIES.md | 0 .../infrastructure/VIRTUAL_ENVIRONMENT.md | 0 .../01_core_planning/00_nextMileston.md | 0 .../planning/01_core_planning/README.md | 0 docs/{project => }/planning/README.md | 0 docs/project/README.md | 90 ++++++++------- .../REPOSITORY_STRUCTURE.md} | 0 .../E2E_TEST_CREATION_SUMMARY.md | 0 .../GITHUB_PULL_SUMMARY.md | 0 .../SQLMODEL_METADATA_FIX_SUMMARY.md | 0 .../REQUIREMENTS_MERGE_SUMMARY.md | 0 .../REQUIREMENTS_MIGRATION_REPORT.md | 0 docs/{project => security}/SECURITY.md | 0 28 files changed, 156 insertions(+), 37 deletions(-) create mode 100644 docs/MERGE_PLAN.md rename docs/{project/2_roadmap.md => ROADMAP.md} (100%) rename docs/{project => }/ai-economics/AI_ECONOMICS_MASTERS.md (100%) rename docs/{project/PROJECT_STRUCTURE.md => archive/GPU_PROJECT_STRUCTURE.md} (100%) rename docs/{project => }/cli/CLI_DOCUMENTATION.md (100%) rename docs/{project => }/completion/PROJECT_COMPLETION_SUMMARY.md (100%) rename docs/{project => development}/workspace/WORKSPACE_STRATEGY.md (100%) rename docs/{project/GIFT_CERTIFICATE_newuser.md => guides/getting-started/GIFT_CERTIFICATE.md} (100%) rename docs/{project/user_profile_newuser.md => guides/getting-started/USER_PROFILE.md} (100%) rename docs/{project => guides/getting-started}/WORKING_SETUP.md (100%) rename docs/{project/3_infrastructure.md => infrastructure/INFRASTRUCTURE.md} (100%) rename docs/{project => }/infrastructure/LOGS_ORGANIZATION.md (100%) rename docs/{project/aitbc.md => infrastructure/NODE_AITBC.md} (100%) rename docs/{project/aitbc1.md => infrastructure/NODE_AITBC1.md} (100%) rename docs/{project => }/infrastructure/PRODUCTION_ARCHITECTURE.md (100%) rename docs/{project => }/infrastructure/RUNTIME_DIRECTORIES.md (100%) rename docs/{project => }/infrastructure/VIRTUAL_ENVIRONMENT.md (100%) rename docs/{project => }/planning/01_core_planning/00_nextMileston.md (100%) rename docs/{project => }/planning/01_core_planning/README.md (100%) rename docs/{project => }/planning/README.md (100%) rename docs/{project/1_files.md => reference/REPOSITORY_STRUCTURE.md} (100%) rename docs/{project => reports}/E2E_TEST_CREATION_SUMMARY.md (100%) rename docs/{project => reports}/GITHUB_PULL_SUMMARY.md (100%) rename docs/{project => reports}/SQLMODEL_METADATA_FIX_SUMMARY.md (100%) rename docs/{project => }/requirements/REQUIREMENTS_MERGE_SUMMARY.md (100%) rename docs/{project => }/requirements/REQUIREMENTS_MIGRATION_REPORT.md (100%) rename docs/{project => security}/SECURITY.md (100%) diff --git a/docs/MERGE_PLAN.md b/docs/MERGE_PLAN.md new file mode 100644 index 00000000..23851d38 --- /dev/null +++ b/docs/MERGE_PLAN.md @@ -0,0 +1,103 @@ +# Documentation Merge Plan for docs/project/ + +## Overview +This document outlines the plan to merge markdown files from `/opt/aitbc/docs/project/` into other doc directories or merge into other md files. + +## Files to Merge + +### Main Files +1. **1_files.md** → `docs/reference/REPOSITORY_STRUCTURE.md` + - Repository file structure documentation + - Fits well in reference section + +2. **2_roadmap.md** → `docs/ROADMAP.md` + - Development roadmap (93KB) + - Should be at root level for easy access + +3. **3_infrastructure.md** → `docs/infrastructure/INFRASTRUCTURE.md` + - Infrastructure documentation (35KB) + - Merge with existing infrastructure docs + +4. **SECURITY.md** → `docs/security/SECURITY.md` + - Security policy + - Merge with existing security docs + +5. **PROJECT_STRUCTURE.md** → `docs/archive/GPU_PROJECT_STRUCTURE.md` + - GPU acceleration project structure (appears outdated/stale) + - Move to archive + +6. **WORKING_SETUP.md** → `docs/guides/getting-started/WORKING_SETUP.md` + - Working setup documentation + - Move to getting started guides + +### Summary Files +7. **E2E_TEST_CREATION_SUMMARY.md** → `docs/reports/E2E_TEST_CREATION_SUMMARY.md` + - Test creation summary + - Move to reports + +8. **SQLMODEL_METADATA_FIX_SUMMARY.md** → `docs/reports/SQLMODEL_METADATA_FIX_SUMMARY.md` + - SQLModel metadata fix summary + - Move to reports + +9. **GITHUB_PULL_SUMMARY.md** → `docs/reports/GITHUB_PULL_SUMMARY.md` + - GitHub pull summary + - Move to reports + +### User-Facing Files +10. **GIFT_CERTIFICATE_newuser.md** → `docs/guides/getting-started/GIFT_CERTIFICATE.md` + - Gift certificate for new users + - Move to getting started guides + +11. **user_profile_newuser.md** → `docs/guides/getting-started/USER_PROFILE.md` + - User profile for new users + - Move to getting started guides + +### Node Documentation +12. **aitbc.md** → `docs/infrastructure/NODE_AITBC.md` + - AITBC server deployment guide + - Move to infrastructure + +13. **aitbc1.md** → `docs/infrastructure/NODE_AITBC1.md` + - AITBC1 server deployment guide + - Move to infrastructure + +### Subdirectories +14. **ai-economics/** → `docs/ai-economics/` + - AI economics documentation + - Move to main docs level + +15. **cli/** → Merge with `docs/cli/` + - CLI documentation + - Merge with existing CLI docs + +16. **completion/** → `docs/completion/` + - Completion documentation + - Move to main docs level + +17. **infrastructure/** → Merge with `docs/infrastructure/` + - Infrastructure documentation + - Merge with existing infrastructure docs + +18. **planning/** → Merge with `docs/planning/` + - Planning documentation + - Merge with existing planning docs + +19. **requirements/** → `docs/requirements/` + - Requirements documentation + - Move to main docs level + +20. **workspace/** → `docs/development/workspace/` + - Workspace documentation + - Move to development + +### Files to Keep +- **README.md** - Well-structured project documentation hub + - Keep as is, serves as landing page + +## Execution Order +1. Create target directories if needed +2. Merge subdirectories first +3. Merge main files +4. Update references +5. Delete original files +6. Update project/README.md to reflect changes diff --git a/docs/project/2_roadmap.md b/docs/ROADMAP.md similarity index 100% rename from docs/project/2_roadmap.md rename to docs/ROADMAP.md diff --git a/docs/project/ai-economics/AI_ECONOMICS_MASTERS.md b/docs/ai-economics/AI_ECONOMICS_MASTERS.md similarity index 100% rename from docs/project/ai-economics/AI_ECONOMICS_MASTERS.md rename to docs/ai-economics/AI_ECONOMICS_MASTERS.md diff --git a/docs/project/PROJECT_STRUCTURE.md b/docs/archive/GPU_PROJECT_STRUCTURE.md similarity index 100% rename from docs/project/PROJECT_STRUCTURE.md rename to docs/archive/GPU_PROJECT_STRUCTURE.md diff --git a/docs/project/cli/CLI_DOCUMENTATION.md b/docs/cli/CLI_DOCUMENTATION.md similarity index 100% rename from docs/project/cli/CLI_DOCUMENTATION.md rename to docs/cli/CLI_DOCUMENTATION.md diff --git a/docs/project/completion/PROJECT_COMPLETION_SUMMARY.md b/docs/completion/PROJECT_COMPLETION_SUMMARY.md similarity index 100% rename from docs/project/completion/PROJECT_COMPLETION_SUMMARY.md rename to docs/completion/PROJECT_COMPLETION_SUMMARY.md diff --git a/docs/project/workspace/WORKSPACE_STRATEGY.md b/docs/development/workspace/WORKSPACE_STRATEGY.md similarity index 100% rename from docs/project/workspace/WORKSPACE_STRATEGY.md rename to docs/development/workspace/WORKSPACE_STRATEGY.md diff --git a/docs/project/GIFT_CERTIFICATE_newuser.md b/docs/guides/getting-started/GIFT_CERTIFICATE.md similarity index 100% rename from docs/project/GIFT_CERTIFICATE_newuser.md rename to docs/guides/getting-started/GIFT_CERTIFICATE.md diff --git a/docs/project/user_profile_newuser.md b/docs/guides/getting-started/USER_PROFILE.md similarity index 100% rename from docs/project/user_profile_newuser.md rename to docs/guides/getting-started/USER_PROFILE.md diff --git a/docs/project/WORKING_SETUP.md b/docs/guides/getting-started/WORKING_SETUP.md similarity index 100% rename from docs/project/WORKING_SETUP.md rename to docs/guides/getting-started/WORKING_SETUP.md diff --git a/docs/project/3_infrastructure.md b/docs/infrastructure/INFRASTRUCTURE.md similarity index 100% rename from docs/project/3_infrastructure.md rename to docs/infrastructure/INFRASTRUCTURE.md diff --git a/docs/project/infrastructure/LOGS_ORGANIZATION.md b/docs/infrastructure/LOGS_ORGANIZATION.md similarity index 100% rename from docs/project/infrastructure/LOGS_ORGANIZATION.md rename to docs/infrastructure/LOGS_ORGANIZATION.md diff --git a/docs/project/aitbc.md b/docs/infrastructure/NODE_AITBC.md similarity index 100% rename from docs/project/aitbc.md rename to docs/infrastructure/NODE_AITBC.md diff --git a/docs/project/aitbc1.md b/docs/infrastructure/NODE_AITBC1.md similarity index 100% rename from docs/project/aitbc1.md rename to docs/infrastructure/NODE_AITBC1.md diff --git a/docs/project/infrastructure/PRODUCTION_ARCHITECTURE.md b/docs/infrastructure/PRODUCTION_ARCHITECTURE.md similarity index 100% rename from docs/project/infrastructure/PRODUCTION_ARCHITECTURE.md rename to docs/infrastructure/PRODUCTION_ARCHITECTURE.md diff --git a/docs/project/infrastructure/RUNTIME_DIRECTORIES.md b/docs/infrastructure/RUNTIME_DIRECTORIES.md similarity index 100% rename from docs/project/infrastructure/RUNTIME_DIRECTORIES.md rename to docs/infrastructure/RUNTIME_DIRECTORIES.md diff --git a/docs/project/infrastructure/VIRTUAL_ENVIRONMENT.md b/docs/infrastructure/VIRTUAL_ENVIRONMENT.md similarity index 100% rename from docs/project/infrastructure/VIRTUAL_ENVIRONMENT.md rename to docs/infrastructure/VIRTUAL_ENVIRONMENT.md diff --git a/docs/project/planning/01_core_planning/00_nextMileston.md b/docs/planning/01_core_planning/00_nextMileston.md similarity index 100% rename from docs/project/planning/01_core_planning/00_nextMileston.md rename to docs/planning/01_core_planning/00_nextMileston.md diff --git a/docs/project/planning/01_core_planning/README.md b/docs/planning/01_core_planning/README.md similarity index 100% rename from docs/project/planning/01_core_planning/README.md rename to docs/planning/01_core_planning/README.md diff --git a/docs/project/planning/README.md b/docs/planning/README.md similarity index 100% rename from docs/project/planning/README.md rename to docs/planning/README.md diff --git a/docs/project/README.md b/docs/project/README.md index b9099a69..4d5949c9 100644 --- a/docs/project/README.md +++ b/docs/project/README.md @@ -23,81 +23,94 @@ ## 📁 **Project Documentation Organization** -This directory contains core project documentation organized by functional areas. All documentation reflects the 100% project completion status. +This directory contains the project documentation hub. Most documentation has been migrated to appropriate locations in the main docs structure. All documentation reflects the 100% project completion status. -### **📋 Directory Structure** +### **📋 Migrated Documentation** -``` -project/ -├── ai-economics/ # AI Economics Masters program -├── cli/ # Command-line interface documentation -├── infrastructure/ # System infrastructure and deployment -├── requirements/ # Project requirements and migration -├── completion/ # 100% project completion summary -└── workspace/ # Workspace strategy and organization -``` +The following documentation has been moved to appropriate locations in the main docs structure: + +- **AI Economics**: Moved to `docs/ai-economics/` +- **CLI Documentation**: Merged into `docs/cli/` +- **Infrastructure**: Merged into `docs/infrastructure/` +- **Planning**: Moved to `docs/planning/` +- **Requirements**: Moved to `docs/requirements/` +- **Completion**: Moved to `docs/completion/` +- **Workspace**: Moved to `docs/development/workspace/` + +### **📋 Key Documentation Locations** + +| Documentation | New Location | +|--------------|-------------| +| Repository Structure | `docs/reference/REPOSITORY_STRUCTURE.md` | +| Roadmap | `docs/ROADMAP.md` | +| Infrastructure | `docs/infrastructure/INFRASTRUCTURE.md` | +| Security | `docs/security/SECURITY.md` | +| Working Setup | `docs/guides/getting-started/WORKING_SETUP.md` | +| Test Creation Summary | `docs/reports/E2E_TEST_CREATION_SUMMARY.md` | +| SQLModel Fix Summary | `docs/reports/SQLMODEL_METADATA_FIX_SUMMARY.md` | +| GitHub Pull Summary | `docs/reports/GITHUB_PULL_SUMMARY.md` | +| Gift Certificate | `docs/guides/getting-started/GIFT_CERTIFICATE.md` | +| User Profile | `docs/guides/getting-started/USER_PROFILE.md` | +| AITBC Node | `docs/infrastructure/NODE_AITBC.md` | +| AITBC1 Node | `docs/infrastructure/NODE_AITBC1.md` | --- -## 🧠 **AI Economics ([ai-economics/](ai-economics/))** +## 🧠 **AI Economics** **Advanced AI Economics Intelligence and Distributed Economic Modeling** -- **AI_ECONOMICS_MASTERS.md**: Complete AI economics transformation program +- **Location**: `docs/ai-economics/AI_ECONOMICS_MASTERS.md` - **Status**: ✅ Production Ready - **Focus**: Distributed AI job economics, marketplace strategy, economic modeling --- -## 💻 **CLI ([cli/](cli/))** +## 💻 **CLI** **Command-Line Interface Documentation** -- **CLI_DOCUMENTATION.md**: Complete CLI reference and usage guide +- **Location**: `docs/cli/` - **Version**: v0.3.0 with enterprise features - **Features**: Authentication, monitoring, type safety commands --- -## 🏗️ **Infrastructure ([infrastructure/](infrastructure/))** +## 🏗️ **Infrastructure** **System Infrastructure and Deployment Documentation** -| File | Purpose | -|------|---------| -| [LOGS_ORGANIZATION.md](infrastructure/LOGS_ORGANIZATION.md) | Log management and organization | -| [PRODUCTION_ARCHITECTURE.md](infrastructure/PRODUCTION_ARCHITECTURE.md) | Production deployment architecture | -| [RUNTIME_DIRECTORIES.md](infrastructure/RUNTIME_DIRECTORIES.md) | Runtime directory structure | -| [VIRTUAL_ENVIRONMENT.md](infrastructure/VIRTUAL_ENVIRONMENT.md) | Virtual environment setup and management | +- **Location**: `docs/infrastructure/` +- **Contents**: Log management, production architecture, runtime directories, virtual environment setup --- -## 📋 **Requirements ([requirements/](requirements/))** +## 📋 **Requirements** **Project Requirements and Migration Documentation** -| File | Purpose | -|------|---------| -| [REQUIREMENTS_MERGE_SUMMARY.md](requirements/REQUIREMENTS_MERGE_SUMMARY.md) | Requirements merge summary | -| [REQUIREMENTS_MIGRATION_REPORT.md](requirements/REQUIREMENTS_MIGRATION_REPORT.md) | Migration process documentation | +- **Location**: `docs/requirements/` +- **Contents**: Requirements merge summary, migration process documentation --- -## ✅ **Completion ([completion/](completion/))** +## ✅ **Completion** **100% Project Completion Documentation** -- **PROJECT_COMPLETION_SUMMARY.md**: Comprehensive project completion summary +- **Location**: `docs/completion/` +- **Contents**: Comprehensive project completion summary - **Status**: ✅ 100% Complete - **Coverage**: All 9 major systems implementation details --- -## 🔧 **Workspace ([workspace/](workspace/))** +## 🔧 **Workspace** **Workspace Strategy and Organization** -- **WORKSPACE_STRATEGY.md**: Workspace organization and development strategy +- **Location**: `docs/development/workspace/` +- **Contents**: Workspace organization and development strategy - **Focus**: Development workflow and project structure --- @@ -127,12 +140,15 @@ project/ ## 🎯 **Quick Access** ### **🎯 I want to...** -- **Understand AI Economics**: [AI Economics Masters](ai-economics/AI_ECONOMICS_MASTERS.md) -- **Use the CLI**: [CLI Documentation](cli/CLI_DOCUMENTATION.md) -- **Set up Infrastructure**: [Infrastructure Guide](infrastructure/) -- **Review Requirements**: [Requirements Documentation](requirements/) -- **See Completion Status**: [Completion Summary](completion/PROJECT_COMPLETION_SUMMARY.md) -- **Organize Workspace**: [Workspace Strategy](workspace/WORKSPACE_STRATEGY.md) +- **Understand AI Economics**: [AI Economics Masters](../ai-economics/AI_ECONOMICS_MASTERS.md) +- **Use the CLI**: [CLI Documentation](../cli/) +- **Set up Infrastructure**: [Infrastructure Guide](../infrastructure/) +- **Review Requirements**: [Requirements Documentation](../requirements/) +- **See Completion Status**: [Completion Summary](../completion/) +- **Organize Workspace**: [Workspace Strategy](../development/workspace/) +- **View Repository Structure**: [Repository Structure](../reference/REPOSITORY_STRUCTURE.md) +- **Check Roadmap**: [Roadmap](../ROADMAP.md) +- **Review Security**: [Security Policy](../security/SECURITY.md) --- diff --git a/docs/project/1_files.md b/docs/reference/REPOSITORY_STRUCTURE.md similarity index 100% rename from docs/project/1_files.md rename to docs/reference/REPOSITORY_STRUCTURE.md diff --git a/docs/project/E2E_TEST_CREATION_SUMMARY.md b/docs/reports/E2E_TEST_CREATION_SUMMARY.md similarity index 100% rename from docs/project/E2E_TEST_CREATION_SUMMARY.md rename to docs/reports/E2E_TEST_CREATION_SUMMARY.md diff --git a/docs/project/GITHUB_PULL_SUMMARY.md b/docs/reports/GITHUB_PULL_SUMMARY.md similarity index 100% rename from docs/project/GITHUB_PULL_SUMMARY.md rename to docs/reports/GITHUB_PULL_SUMMARY.md diff --git a/docs/project/SQLMODEL_METADATA_FIX_SUMMARY.md b/docs/reports/SQLMODEL_METADATA_FIX_SUMMARY.md similarity index 100% rename from docs/project/SQLMODEL_METADATA_FIX_SUMMARY.md rename to docs/reports/SQLMODEL_METADATA_FIX_SUMMARY.md diff --git a/docs/project/requirements/REQUIREMENTS_MERGE_SUMMARY.md b/docs/requirements/REQUIREMENTS_MERGE_SUMMARY.md similarity index 100% rename from docs/project/requirements/REQUIREMENTS_MERGE_SUMMARY.md rename to docs/requirements/REQUIREMENTS_MERGE_SUMMARY.md diff --git a/docs/project/requirements/REQUIREMENTS_MIGRATION_REPORT.md b/docs/requirements/REQUIREMENTS_MIGRATION_REPORT.md similarity index 100% rename from docs/project/requirements/REQUIREMENTS_MIGRATION_REPORT.md rename to docs/requirements/REQUIREMENTS_MIGRATION_REPORT.md diff --git a/docs/project/SECURITY.md b/docs/security/SECURITY.md similarity index 100% rename from docs/project/SECURITY.md rename to docs/security/SECURITY.md