zwitschi/linearvoid
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 9 Wiki Activity

Add comprehensive documentation for Linear Void project

Browse Source 
- Created README.md in docs folder outlining project structure and documentation links.
- Added SECURITY.md detailing the security model, threat model, authentication, transport security, network isolation, and incident response procedures.
- Introduced SETUP.md providing a detailed setup guide for local and production environments, including prerequisites, environment setup, and Gitea integration.
- Added STREAMING.md outlining the streaming pipeline, including production flow, source-media contract, playout and HLS packaging, cache contract, player behavior, and monitoring.
- Updated architecture documentation to include links to new SETUP.md and STREAMING.md files for better navigation.
This commit is contained in:
zwitschi committed 2026-08-08 14:52:19 +02:00
1 parent 6b9830de05
commit 926a663c23
10 files changed
+54 -13
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

README.md
+6 -6
View File
@@ -206,11 +206,11 @@ Contributions, issues, and further evolution (LL-HLS, ABR, multi-channel, E2EE)
- [CHANGELOG.md](CHANGELOG.md) - Version history and completed features.
- [CONTRIBUTING.md](CONTRIBUTING.md) - Guidelines for contributing to the project.
- [SETUP.md](SETUP.md) - Complete setup guide with prerequisites, environment configuration, running the application, and troubleshooting.
- [API.md](API.md) - Implemented WebSocket and REST API reference.
- [DEPLOYMENT.md](DEPLOYMENT.md) - Production deployment and operations guide.
- [MONITORING.md](MONITORING.md) - Prometheus and Grafana setup and troubleshooting.
- [SECURITY.md](SECURITY.md) - Security controls, hardening checklist, and incident baseline.
- [SETUP.md](docs/SETUP.md) - Complete setup guide with prerequisites, environment configuration, running the application, and troubleshooting.
- [API.md](docs/API.md) - Implemented WebSocket and REST API reference.
- [DEPLOYMENT.md](docs/DEPLOYMENT.md) - Production deployment and operations guide.
- [MONITORING.md](docs/MONITORING.md) - Prometheus and Grafana setup and troubleshooting.
- [SECURITY.md](docs/SECURITY.md) - Security controls, hardening checklist, and incident baseline.
- [Scaling Playbook](docs/operations/scaling-performance-playbook.md) - Performance test method, thresholds, and scaling decision flow.
- [Architecture Documentation](docs/architecture/README.md) - Full arc42 template with diagrams and decisions.
- [ADRs](docs/architecture/adr/) - Detailed decision records (ADR-001 to ADR-007).
@@ -232,4 +232,4 @@ Since this is a linear project, we also rely on a linear development and release
[MIT License](LICENSE)
The project is ready for use. See [`SETUP.md`](SETUP.md) for detailed installation instructions.
The project is ready for use. See [`SETUP.md`](docs/SETUP.md) for detailed installation instructions.