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:
56
docs/refactor/routes/README.md
Normal file
56
docs/refactor/routes/README.md
Normal file
@@ -0,0 +1,56 @@
|
||||
# ROUTE REFACTORING PLANS
|
||||
|
||||
**Purpose**: Documentation for API route refactoring and reorganization.
|
||||
|
||||
---
|
||||
|
||||
## Current Route Structure
|
||||
|
||||
### Backend Routes
|
||||
- `/api/v1/planner/` - Planner module routes
|
||||
- `/api/v1/writer/` - Writer module routes
|
||||
- `/api/v1/thinker/` - Thinker module routes
|
||||
- `/api/v1/system/` - System module routes
|
||||
- `/api/v1/billing/` - Billing module routes
|
||||
- `/api/v1/auth/` - Authentication routes
|
||||
|
||||
### Frontend Routes
|
||||
- `/planner/*` - Planner pages
|
||||
- `/writer/*` - Writer pages
|
||||
- `/thinker/*` - Thinker pages
|
||||
- `/settings/*` - Settings pages
|
||||
- `/billing/*` - Billing pages
|
||||
|
||||
---
|
||||
|
||||
## Planned Route Changes
|
||||
|
||||
### Phase 1: Service Layer Routes
|
||||
- New routes for service-based endpoints
|
||||
- Domain-specific route organization
|
||||
|
||||
### Phase 2: New Module Routes
|
||||
- `/api/v1/automation/` - Automation routes
|
||||
- `/api/v1/linker/` - Linker routes
|
||||
- `/api/v1/optimizer/` - Optimizer routes
|
||||
- `/api/v1/site-builder/` - Site Builder routes
|
||||
- `/api/v1/integration/` - Integration routes
|
||||
|
||||
### Phase 3: Frontend Route Updates
|
||||
- New module pages
|
||||
- Route guards for module access
|
||||
- Conditional route loading
|
||||
|
||||
---
|
||||
|
||||
## Migration Strategy
|
||||
|
||||
1. Add new routes alongside existing routes
|
||||
2. Gradually migrate endpoints to new structure
|
||||
3. Maintain backward compatibility
|
||||
4. Update frontend routes incrementally
|
||||
|
||||
---
|
||||
|
||||
**Last Updated**: 2025-01-XX
|
||||
|
||||
Reference in New Issue
Block a user