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
|
├── CONTEXT.md # Full project description
|
||||||
├── TODO.md # Task list & roadmap
|
├── TODO.md # Task list & roadmap
|
||||||
├── ARCHITECTURE.md # Technical details
|
├── 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
|
├── 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
|
## 🚀 Getting Started
|
||||||
|
|||||||
@@ -168,8 +168,10 @@ const wyslijWiadomosc = (wiadomosc) => {
|
|||||||
**For full details:**
|
**For full details:**
|
||||||
- `docs/ARCHITECTURE.md` - Szczegóły techniczne, implementacja, WebRTC flow
|
- `docs/ARCHITECTURE.md` - Szczegóły techniczne, implementacja, WebRTC flow
|
||||||
- `docs/TODO.md` - Lista zadań i roadmap
|
- `docs/TODO.md` - Lista zadań i roadmap
|
||||||
- `docs/COMPLETED.md` - Archiwum ukończonych zadań
|
- `docs/DEPLOYMENT.md` - Production deployment guide
|
||||||
- `docs/RESOURCES.md` - Linki do dokumentacji i zasobów edukacyjnych
|
- `docs/MONITORING.md` - Monitoring and operations
|
||||||
|
- `docs/archive/COMPLETED.md` - Archiwum ukończonych zadań
|
||||||
|
- `docs/archive/RESOURCES.md` - Linki do dokumentacji i zasobów edukacyjnych
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
@@ -273,7 +273,7 @@ Logs are configured with rotation:
|
|||||||
- [ ] Configure firewall (allow only 80, 443, 22)
|
- [ ] Configure firewall (allow only 80, 443, 22)
|
||||||
- [ ] Set up automated backups
|
- [ ] Set up automated backups
|
||||||
- [ ] Configure monitoring/alerting
|
- [ ] Configure monitoring/alerting
|
||||||
- [ ] Review security audit report (`docs/SECURITY_AUDIT.md`)
|
- [ ] Review security audit report (`docs/archive/SECURITY_AUDIT.md`)
|
||||||
|
|
||||||
### After Deployment
|
### After Deployment
|
||||||
|
|
||||||
@@ -442,7 +442,7 @@ docker exec spotlightcam-db-prod pg_dump -U spotlightcam spotlightcam > backup.s
|
|||||||
|
|
||||||
For issues:
|
For issues:
|
||||||
1. Check logs: `docker compose logs`
|
1. Check logs: `docker compose logs`
|
||||||
2. Review security audit: `docs/SECURITY_AUDIT.md`
|
2. Review security audit: `docs/archive/SECURITY_AUDIT.md`
|
||||||
3. Check session context: `docs/SESSION_CONTEXT.md`
|
3. Check session context: `docs/SESSION_CONTEXT.md`
|
||||||
4. Review phase documentation: `docs/PHASE_*.md`
|
4. Review phase documentation: `docs/PHASE_*.md`
|
||||||
|
|
||||||
|
|||||||
@@ -59,7 +59,7 @@
|
|||||||
2. Check Socket.IO is connected (message input not disabled)
|
2. Check Socket.IO is connected (message input not disabled)
|
||||||
3. Check browser console for errors
|
3. Check browser console for errors
|
||||||
4. Try refreshing both windows
|
4. Try refreshing both windows
|
||||||
5. See WEBRTC_TESTING_GUIDE.md for detailed troubleshooting
|
5. See docs/WEBRTC_TESTING_GUIDE.md for detailed troubleshooting
|
||||||
|
|
||||||
## Start Testing
|
## Start Testing
|
||||||
|
|
||||||
@@ -119,8 +119,11 @@
|
|||||||
├── CONTEXT.md # Full project description
|
├── CONTEXT.md # Full project description
|
||||||
├── TODO.md # Task list
|
├── TODO.md # Task list
|
||||||
├── ARCHITECTURE.md # Technical details
|
├── ARCHITECTURE.md # Technical details
|
||||||
├── COMPLETED.md # Completed tasks archive
|
├── QUICKSTART.md # Quick start guide
|
||||||
└── RESOURCES.md # Learning resources
|
├── WEBRTC_TESTING_GUIDE.md # WebRTC testing
|
||||||
|
└── archive/ # Archived docs
|
||||||
|
├── COMPLETED.md # Completed tasks archive
|
||||||
|
└── RESOURCES.md # Learning resources
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
@@ -438,8 +441,8 @@ RUN apk add --no-cache openssl
|
|||||||
- `docs/ARCHITECTURE.md` (technical details)
|
- `docs/ARCHITECTURE.md` (technical details)
|
||||||
|
|
||||||
**Archives:**
|
**Archives:**
|
||||||
- `docs/COMPLETED.md` (completed tasks)
|
- `docs/archive/COMPLETED.md` (completed tasks archive)
|
||||||
- `docs/RESOURCES.md` (learning resources)
|
- `docs/archive/RESOURCES.md` (learning resources)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
22
docs/TODO.md
22
docs/TODO.md
@@ -109,7 +109,7 @@
|
|||||||
- Message history persistence
|
- Message history persistence
|
||||||
- Duplicate rating prevention
|
- Duplicate rating prevention
|
||||||
|
|
||||||
**See:** `docs/COMPLETED.md` for full list of completed tasks
|
**See:** `docs/archive/COMPLETED.md` for full list of completed tasks
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -478,13 +478,15 @@
|
|||||||
|
|
||||||
### Documentation
|
### Documentation
|
||||||
- [x] ✅ README.md
|
- [x] ✅ README.md
|
||||||
- [x] ✅ QUICKSTART.md
|
- [x] ✅ docs/QUICKSTART.md
|
||||||
- [x] ✅ CONTEXT.md
|
- [x] ✅ docs/CONTEXT.md
|
||||||
- [x] ✅ TODO.md
|
- [x] ✅ docs/TODO.md
|
||||||
- [x] ✅ SESSION_CONTEXT.md
|
- [x] ✅ docs/SESSION_CONTEXT.md
|
||||||
- [x] ✅ ARCHITECTURE.md
|
- [x] ✅ docs/ARCHITECTURE.md
|
||||||
- [x] ✅ COMPLETED.md
|
- [x] ✅ docs/DEPLOYMENT.md
|
||||||
- [x] ✅ RESOURCES.md
|
- [x] ✅ docs/MONITORING.md
|
||||||
|
- [x] ✅ docs/archive/COMPLETED.md
|
||||||
|
- [x] ✅ docs/archive/RESOURCES.md
|
||||||
- [ ] ⏳ API documentation (Swagger/OpenAPI) - after backend
|
- [ ] ⏳ API documentation (Swagger/OpenAPI) - after backend
|
||||||
- [ ] ⏳ Architecture diagrams - after backend
|
- [ ] ⏳ Architecture diagrams - after backend
|
||||||
- [ ] ⏳ WebRTC flow diagram - after WebRTC implementation
|
- [ ] ⏳ WebRTC flow diagram - after WebRTC implementation
|
||||||
@@ -562,8 +564,8 @@ git commit -m "feat: description"
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**For detailed task history:** See `docs/COMPLETED.md`
|
**For detailed task history:** See `docs/archive/COMPLETED.md`
|
||||||
**For learning resources:** See `docs/RESOURCES.md`
|
**For learning resources:** See `docs/archive/RESOURCES.md`
|
||||||
**For quick session context:** See `docs/SESSION_CONTEXT.md`
|
**For quick session context:** See `docs/SESSION_CONTEXT.md`
|
||||||
**For technical details:** See `docs/ARCHITECTURE.md`
|
**For technical details:** See `docs/ARCHITECTURE.md`
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user