docs: reorganize documentation structure for better context efficiency
Reorganization changes: 1. Moved from root → docs/: - QUICKSTART.md - QUICK_TEST.md - WEBRTC_TESTING_GUIDE.md 2. Created docs/archive/ and moved archival files: - COMPLETED.md (completed tasks archive) - PHASE_1.5.md (historical phase documentation) - RESOURCES.md (learning resources) - SECURITY_AUDIT.md (security audit) - ADMIN_CLI.md (CLI documentation) 3. Updated all references in: - README.md - docs/CONTEXT.md - docs/TODO.md - docs/SESSION_CONTEXT.md - docs/DEPLOYMENT.md - docs/QUICK_TEST.md Active docs/ now contains only essential files: - SESSION_CONTEXT.md (primary for context restoration) - TODO.md - CONTEXT.md - ARCHITECTURE.md - DEPLOYMENT.md - MONITORING.md - QUICKSTART.md - QUICK_TEST.md - WEBRTC_TESTING_GUIDE.md Benefits: - Reduced token usage when reading docs/ for context - Clear separation between active and archived documentation - Better organization for future maintenance
This commit is contained in:
14
README.md
14
README.md
@@ -162,11 +162,17 @@ spotlightcam/
|
||||
├── CONTEXT.md # Full project description
|
||||
├── TODO.md # Task list & roadmap
|
||||
├── ARCHITECTURE.md # Technical details
|
||||
├── COMPLETED.md # Completed tasks archive
|
||||
├── PHASE_1.5.md # Phase 1.5 documentation
|
||||
├── SECURITY_AUDIT.md # Security audit & fixes
|
||||
├── DEPLOYMENT.md # Deployment guide
|
||||
└── RESOURCES.md # Learning resources
|
||||
├── MONITORING.md # Monitoring & operations
|
||||
├── QUICKSTART.md # Quick start guide
|
||||
├── QUICK_TEST.md # Quick test instructions
|
||||
├── WEBRTC_TESTING_GUIDE.md # WebRTC testing guide
|
||||
└── archive/ # Archived documentation
|
||||
├── COMPLETED.md # Completed tasks archive
|
||||
├── PHASE_1.5.md # Phase 1.5 documentation
|
||||
├── SECURITY_AUDIT.md # Security audit & fixes
|
||||
├── RESOURCES.md # Learning resources
|
||||
└── ADMIN_CLI.md # Admin CLI documentation
|
||||
```
|
||||
|
||||
## 🚀 Getting Started
|
||||
|
||||
Reference in New Issue
Block a user