mirror of https://github.com/johndoe6345789/metabuilder.git synced 2026-04-25 14:25:02 +00:00

Files

copilot-swe-agent[bot] 082c687325 Move documentation files to docs folder

Co-authored-by: johndoe6345789 <224850594+johndoe6345789@users.noreply.github.com>

2025-12-27 13:36:33 +00:00

3.9 KiB

Raw Permalink Blame History

DBAL Folder Restructure: Before & After

Before (Old Structure)

dbal/
├── README.md
├── AGENTS.md
├── LICENSE
├── PROJECT.md
├── IMPLEMENTATION_SUMMARY.md
├── PHASE2_COMPLETE.md
├── PHASE2_IMPLEMENTATION.md
├── QUICK_START.md
├── README_INDEX.md
├── .gitignore
│
├── ts/                      # TypeScript implementation
│   ├── src/
│   ├── tests/
│   ├── package.json
│   └── tsconfig.json
│
├── cpp/                     # C++ implementation
│   ├── src/
│   ├── include/
│   ├── tests/
│   ├── docs/
│   ├── build-config/
│   └── lint-config/
│
├── api/                     # API specifications
│   ├── schema/
│   └── versioning/
│
├── backends/                # Backend schemas
│   ├── prisma/
│   └── sqlite/
│
├── common/                  # Shared utilities
│   └── contracts/
│
├── tools/                   # Development tools
│   ├── codegen/
│   └── conformance/
│
├── scripts/                 # Utility scripts
└── docs/                    # Additional docs

Issues:

8 top-level folders + 9 files = cluttered root
Not immediately clear which folders are for which implementation
Shared resources mixed at root level

After (New Structure) ✨

dbal/
├── README.md                # Core documentation
├── README_INDEX.md
├── PROJECT.md
├── AGENTS.md
├── RESTRUCTURE_SUMMARY.md
├── LICENSE
├── .gitignore
│
├── development/             # 🟦 TypeScript (fast iteration)
│   ├── src/
│   ├── tests/
│   ├── package.json
│   ├── tsconfig.json
│   └── .gitignore
│
├── production/              # 🟨 C++ (security & performance)
│   ├── src/
│   ├── include/
│   ├── tests/
│   ├── docs/
│   ├── build-config/
│   └── lint-config/
│
└── shared/                  # 🟩 Shared resources
    ├── api/                 # API specifications
    │   ├── schema/
    │   └── versioning/
    ├── backends/            # Backend schemas
    │   ├── prisma/
    │   └── sqlite/
    ├── common/              # Shared utilities
    │   └── contracts/
    ├── tools/               # Development tools
    │   ├── codegen/
    │   └── conformance/
    ├── scripts/             # Utility scripts
    └── docs/                # Additional documentation
        ├── IMPLEMENTATION_SUMMARY.md
        ├── PHASE2_COMPLETE.md
        ├── PHASE2_IMPLEMENTATION.md
        └── QUICK_START.md

Benefits:

✅ 3 top-level folders + documentation files = clean root
✅ Clear purpose: development/ vs production/ vs shared/
✅ Better organization: All shared resources in one place
✅ Easier navigation: Developers know exactly where to look
✅ Consistent naming: Matches the project's description of TypeScript for development and C++ for production

Migration Summary

Folder Renames

dbal/ts/ → dbal/development/
dbal/cpp/ → dbal/production/

Consolidated into `shared/`

dbal/api/ → dbal/shared/api/
dbal/backends/ → dbal/shared/backends/
dbal/common/ → dbal/shared/common/
dbal/tools/ → dbal/shared/tools/
dbal/scripts/ → dbal/shared/scripts/
dbal/docs/ → dbal/shared/docs/

Files Reorganized

Historical implementation docs moved to shared/docs/
Core documentation remains at root
Each implementation has its own .gitignore

References Updated

80+ files updated across entire project
0 old references remaining
All workflows, documentation, and code updated

3.9 KiB Raw Permalink Blame History