radziel/spotlightcam
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: reorganize documentation structure for better context efficiency

Browse Source 
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:
Radosław Gierwiało
2025-11-20 22:42:06 +01:00
parent 1463b83882
commit 975d258497
13 changed files with 36 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/TODO.md
View File

@@ -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`