docs: merge docs/project files into appropriate doc directories
Some checks failed
Cross-Node Transaction Testing / transaction-test (push) Successful in 3s
Deploy to Testnet / deploy-testnet (push) Successful in 1m6s
Documentation Validation / validate-docs (push) Failing after 9s
Documentation Validation / validate-policies-strict (push) Successful in 5s
Multi-Node Stress Testing / stress-test (push) Successful in 3s
Node Failover Simulation / failover-test (push) Failing after 4s

- 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
This commit is contained in:
aitbc
2026-05-09 21:52:55 +02:00
parent 157048ea1f
commit a7fbf58462
28 changed files with 156 additions and 37 deletions

103
docs/MERGE_PLAN.md Normal file
View File

@@ -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

View File

@@ -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)
---