Organize planning documents and update README structure

- Created a new `docs/planning/` directory to better organize architecture and implementation planning documents.
- Moved existing planning documents into the new directory for improved accessibility.
- Updated `README.md` to reflect the new document structure and added references to the organized planning documents.
- Enhanced overall documentation management for easier navigation and maintenance.
This commit is contained in:
IGNY8 VPS (Salman)
2025-11-16 17:41:30 +00:00
parent 4561f73afb
commit 76a363b3d5
14 changed files with 2922 additions and 664 deletions

View File

@@ -0,0 +1,64 @@
# FOLDER STRUCTURE REFACTORING PLANS
**Purpose**: Documentation for folder structure refactoring and reorganization.
---
## Current Structure
```
backend/igny8_core/
├── modules/ # Feature modules
├── ai/ # AI framework
├── api/ # API base classes
└── middleware/ # Custom middleware
```
---
## Planned Structure (Domain-Driven)
```
backend/igny8_core/
├── core/ # Core models (Account, User, Site, Sector)
├── domain/ # Domain-specific code
│ ├── content/ # Content domain
│ ├── planning/ # Planning domain
│ ├── linking/ # Linking domain
│ ├── optimization/# Optimization domain
│ ├── site_building/# Site building domain
│ ├── integration/ # Integration domain
│ └── billing/ # Billing domain
├── infrastructure/ # Infrastructure code
│ ├── ai/ # AI framework
│ ├── storage/ # Storage services
│ └── queue/ # Queue management
├── modules/ # Module ViewSets (thin layer)
├── shared/ # Shared utilities
└── api/ # API base classes
```
---
## Migration Strategy
1. Create new domain folders
2. Move models to domain folders
3. Create service layer in domain folders
4. Update imports incrementally
5. Keep modules folder for ViewSets only
---
## File Organization Rules
- **Models**: `domain/{domain}/models.py`
- **Services**: `domain/{domain}/services/`
- **Serializers**: `modules/{module}/serializers.py`
- **ViewSets**: `modules/{module}/views.py`
- **URLs**: `modules/{module}/urls.py`
---
**Last Updated**: 2025-01-XX