101 lines
3.7 KiB
Markdown
101 lines
3.7 KiB
Markdown
# Root File Relocation Plan
|
|
|
|
## Date: 2024-11-21
|
|
|
|
## Strategy
|
|
|
|
Keep essential files in root for visibility, relocate specialized documentation to appropriate directories.
|
|
|
|
## Files to Keep in Root
|
|
|
|
### Essential Files (Standard Locations)
|
|
- ✅ `README.md` - Main project entry point
|
|
- ✅ `CHANGELOG.md` - Standard location for changelog
|
|
- ✅ `CONTRIBUTING.md` - Standard location for contribution guidelines
|
|
- ✅ `LICENSE` - Standard location for license
|
|
- ✅ `docs/setup/GETTING_STARTED.md` - Quick start guide (high visibility)
|
|
- ✅ `PROGRESS_REPORTS/PROJECT_STATUS.md` - Current status (high visibility)
|
|
|
|
## Files to Relocate
|
|
|
|
### Planning Documents → `docs/planning/`
|
|
1. **docs/planning/PROJECT_CHARTER.md** → `docs/planning/docs/planning/PROJECT_CHARTER.md`
|
|
- Planning document, belongs with other planning docs
|
|
|
|
2. **docs/planning/PROJECT_PLAN.md** → `docs/planning/docs/planning/PROJECT_PLAN.md`
|
|
- 90-day roadmap, planning document
|
|
|
|
3. **docs/planning/DISTRICT_SELECTION.md** → `docs/planning/docs/planning/DISTRICT_SELECTION.md`
|
|
- District selection analysis, planning document
|
|
|
|
4. **docs/planning/MILESTONES.md** → `docs/planning/docs/planning/MILESTONES.md`
|
|
- Milestone tracking, planning document
|
|
|
|
### Technical Documentation → `docs/`
|
|
5. **docs/TECHNICAL_BRIEF.md** → `docs/docs/TECHNICAL_BRIEF.md`
|
|
- Technical specifications, core technical doc
|
|
|
|
6. **docs/TECHNICAL_SPECS.md** → `docs/docs/TECHNICAL_SPECS.md`
|
|
- Final technical specs, core technical doc
|
|
|
|
7. **docs/setup/PROJECT_SETTINGS.md** → `docs/setup/docs/setup/PROJECT_SETTINGS.md`
|
|
- Engine settings, setup documentation
|
|
|
|
8. **docs/setup/PLUGINS.md** → `docs/setup/docs/setup/PLUGINS.md`
|
|
- Plugin requirements, setup documentation
|
|
|
|
9. **docs/setup/VERSION_CONTROL.md** → `docs/setup/docs/setup/VERSION_CONTROL.md`
|
|
- Version control setup, setup documentation
|
|
|
|
10. **docs/PIPELINE.md** → `docs/docs/PIPELINE.md`
|
|
- Development pipeline, core technical doc
|
|
|
|
11. **docs/NAMING_CONVENTIONS.md** → `docs/docs/NAMING_CONVENTIONS.md`
|
|
- Naming standards, technical documentation
|
|
|
|
### Art Documentation → `docs/`
|
|
12. **docs/ART_BIBLE.md** → `docs/docs/ART_BIBLE.md`
|
|
- Art direction, core documentation
|
|
|
|
### Reference/Summary → `docs/reference/`
|
|
13. **docs/reference/ASSET_REVIEW_SUMMARY.md** → `docs/reference/docs/reference/ASSET_REVIEW_SUMMARY.md`
|
|
- Asset review summary, reference material
|
|
|
|
14. **docs/reference/WORKFLOW_REVIEW_SUMMARY.md** → `docs/reference/docs/reference/WORKFLOW_REVIEW_SUMMARY.md`
|
|
- Workflow review summary, reference material
|
|
|
|
### Setup Guides → `docs/setup/`
|
|
15. **docs/setup/NEXT_STEPS_AFTER_BUILD.md** → `docs/setup/docs/setup/NEXT_STEPS_AFTER_BUILD.md`
|
|
- Post-build setup guide
|
|
|
|
16. **docs/setup/PARALLEL_TASKS_WHILE_BUILDING.md** → `docs/setup/docs/setup/PARALLEL_TASKS_WHILE_BUILDING.md`
|
|
- Build-time tasks guide
|
|
|
|
### Project Management → `docs/` or keep
|
|
17. **docs/PROJECT_HEALTH.md** → `docs/docs/PROJECT_HEALTH.md`
|
|
- Health dashboard, project management doc
|
|
|
|
18. **PROGRESS_REPORTS/DEVELOPMENT_LOG.md** → `PROGRESS_REPORTS/PROGRESS_REPORTS/DEVELOPMENT_LOG.md`
|
|
- Development log, progress tracking
|
|
|
|
19. **docs/reference/COMMAND_REFERENCE.md** → `docs/reference/docs/reference/COMMAND_REFERENCE.md`
|
|
- Command reference, reference material
|
|
|
|
## Execution Steps
|
|
|
|
1. Create target directories if needed
|
|
2. Move files to new locations
|
|
3. Update all references in documentation
|
|
4. Update README.md links
|
|
5. Update docs/README.md links
|
|
6. Verify no broken links
|
|
7. Update CHANGELOG.md
|
|
|
|
## Expected Results
|
|
|
|
- Root directory: 6 essential files
|
|
- Better organization by category
|
|
- Easier navigation
|
|
- Standard project structure
|
|
|