From 975d258497c298b7d90e26f29f9c186a1f007c2a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rados=C5=82aw=20Gierwia=C5=82o?= Date: Thu, 20 Nov 2025 22:42:06 +0100 Subject: [PATCH] docs: reorganize documentation structure for better context efficiency MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 --- README.md | 14 ++++++++---- docs/CONTEXT.md | 6 +++-- docs/DEPLOYMENT.md | 4 ++-- QUICKSTART.md => docs/QUICKSTART.md | 0 QUICK_TEST.md => docs/QUICK_TEST.md | 2 +- docs/SESSION_CONTEXT.md | 11 ++++++---- docs/TODO.md | 22 ++++++++++--------- .../WEBRTC_TESTING_GUIDE.md | 0 docs/{ => archive}/ADMIN_CLI.md | 0 docs/{ => archive}/COMPLETED.md | 0 docs/{ => archive}/PHASE_1.5.md | 0 docs/{ => archive}/RESOURCES.md | 0 docs/{ => archive}/SECURITY_AUDIT.md | 0 13 files changed, 36 insertions(+), 23 deletions(-) rename QUICKSTART.md => docs/QUICKSTART.md (100%) rename QUICK_TEST.md => docs/QUICK_TEST.md (96%) rename WEBRTC_TESTING_GUIDE.md => docs/WEBRTC_TESTING_GUIDE.md (100%) rename docs/{ => archive}/ADMIN_CLI.md (100%) rename docs/{ => archive}/COMPLETED.md (100%) rename docs/{ => archive}/PHASE_1.5.md (100%) rename docs/{ => archive}/RESOURCES.md (100%) rename docs/{ => archive}/SECURITY_AUDIT.md (100%) diff --git a/README.md b/README.md index baec2f9..944269d 100644 --- a/README.md +++ b/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 diff --git a/docs/CONTEXT.md b/docs/CONTEXT.md index 0220a3b..94a14c0 100644 --- a/docs/CONTEXT.md +++ b/docs/CONTEXT.md @@ -168,8 +168,10 @@ const wyslijWiadomosc = (wiadomosc) => { **For full details:** - `docs/ARCHITECTURE.md` - Szczegóły techniczne, implementacja, WebRTC flow - `docs/TODO.md` - Lista zadań i roadmap -- `docs/COMPLETED.md` - Archiwum ukończonych zadań -- `docs/RESOURCES.md` - Linki do dokumentacji i zasobów edukacyjnych +- `docs/DEPLOYMENT.md` - Production deployment guide +- `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 --- diff --git a/docs/DEPLOYMENT.md b/docs/DEPLOYMENT.md index 90b195b..e00c057 100644 --- a/docs/DEPLOYMENT.md +++ b/docs/DEPLOYMENT.md @@ -273,7 +273,7 @@ Logs are configured with rotation: - [ ] Configure firewall (allow only 80, 443, 22) - [ ] Set up automated backups - [ ] Configure monitoring/alerting -- [ ] Review security audit report (`docs/SECURITY_AUDIT.md`) +- [ ] Review security audit report (`docs/archive/SECURITY_AUDIT.md`) ### After Deployment @@ -442,7 +442,7 @@ docker exec spotlightcam-db-prod pg_dump -U spotlightcam spotlightcam > backup.s For issues: 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` 4. Review phase documentation: `docs/PHASE_*.md` diff --git a/QUICKSTART.md b/docs/QUICKSTART.md similarity index 100% rename from QUICKSTART.md rename to docs/QUICKSTART.md diff --git a/QUICK_TEST.md b/docs/QUICK_TEST.md similarity index 96% rename from QUICK_TEST.md rename to docs/QUICK_TEST.md index c9924c5..05412c9 100644 --- a/QUICK_TEST.md +++ b/docs/QUICK_TEST.md @@ -59,7 +59,7 @@ 2. Check Socket.IO is connected (message input not disabled) 3. Check browser console for errors 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 diff --git a/docs/SESSION_CONTEXT.md b/docs/SESSION_CONTEXT.md index dea885c..3d8cc7e 100644 --- a/docs/SESSION_CONTEXT.md +++ b/docs/SESSION_CONTEXT.md @@ -119,8 +119,11 @@ ├── CONTEXT.md # Full project description ├── TODO.md # Task list ├── ARCHITECTURE.md # Technical details - ├── COMPLETED.md # Completed tasks archive - └── RESOURCES.md # Learning resources + ├── QUICKSTART.md # Quick start guide + ├── 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) **Archives:** -- `docs/COMPLETED.md` (completed tasks) -- `docs/RESOURCES.md` (learning resources) +- `docs/archive/COMPLETED.md` (completed tasks archive) +- `docs/archive/RESOURCES.md` (learning resources) --- diff --git a/docs/TODO.md b/docs/TODO.md index 69dc8ad..2daa07f 100644 --- a/docs/TODO.md +++ b/docs/TODO.md @@ -109,7 +109,7 @@ - Message history persistence - 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 - [x] ✅ README.md -- [x] ✅ QUICKSTART.md -- [x] ✅ CONTEXT.md -- [x] ✅ TODO.md -- [x] ✅ SESSION_CONTEXT.md -- [x] ✅ ARCHITECTURE.md -- [x] ✅ COMPLETED.md -- [x] ✅ RESOURCES.md +- [x] ✅ docs/QUICKSTART.md +- [x] ✅ docs/CONTEXT.md +- [x] ✅ docs/TODO.md +- [x] ✅ docs/SESSION_CONTEXT.md +- [x] ✅ docs/ARCHITECTURE.md +- [x] ✅ docs/DEPLOYMENT.md +- [x] ✅ docs/MONITORING.md +- [x] ✅ docs/archive/COMPLETED.md +- [x] ✅ docs/archive/RESOURCES.md - [ ] ⏳ API documentation (Swagger/OpenAPI) - after backend - [ ] ⏳ Architecture diagrams - after backend - [ ] ⏳ WebRTC flow diagram - after WebRTC implementation @@ -562,8 +564,8 @@ git commit -m "feat: description" --- -**For detailed task history:** See `docs/COMPLETED.md` -**For learning resources:** See `docs/RESOURCES.md` +**For detailed task history:** See `docs/archive/COMPLETED.md` +**For learning resources:** See `docs/archive/RESOURCES.md` **For quick session context:** See `docs/SESSION_CONTEXT.md` **For technical details:** See `docs/ARCHITECTURE.md` diff --git a/WEBRTC_TESTING_GUIDE.md b/docs/WEBRTC_TESTING_GUIDE.md similarity index 100% rename from WEBRTC_TESTING_GUIDE.md rename to docs/WEBRTC_TESTING_GUIDE.md diff --git a/docs/ADMIN_CLI.md b/docs/archive/ADMIN_CLI.md similarity index 100% rename from docs/ADMIN_CLI.md rename to docs/archive/ADMIN_CLI.md diff --git a/docs/COMPLETED.md b/docs/archive/COMPLETED.md similarity index 100% rename from docs/COMPLETED.md rename to docs/archive/COMPLETED.md diff --git a/docs/PHASE_1.5.md b/docs/archive/PHASE_1.5.md similarity index 100% rename from docs/PHASE_1.5.md rename to docs/archive/PHASE_1.5.md diff --git a/docs/RESOURCES.md b/docs/archive/RESOURCES.md similarity index 100% rename from docs/RESOURCES.md rename to docs/archive/RESOURCES.md diff --git a/docs/SECURITY_AUDIT.md b/docs/archive/SECURITY_AUDIT.md similarity index 100% rename from docs/SECURITY_AUDIT.md rename to docs/archive/SECURITY_AUDIT.md