Add comprehensive documentation for Linear Void project
- 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:
1 parent
6b9830de05
commit
926a663c23
10 files changed
+54
-13
No files matched your search
@@ -206,11 +206,11 @@ Contributions, issues, and further evolution (LL-HLS, ABR, multi-channel, E2EE)
|
|||||||
|
|
||||||
- [CHANGELOG.md](CHANGELOG.md) - Version history and completed features.
|
- [CHANGELOG.md](CHANGELOG.md) - Version history and completed features.
|
||||||
- [CONTRIBUTING.md](CONTRIBUTING.md) - Guidelines for contributing to the project.
|
- [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.
|
- [SETUP.md](docs/SETUP.md) - Complete setup guide with prerequisites, environment configuration, running the application, and troubleshooting.
|
||||||
- [API.md](API.md) - Implemented WebSocket and REST API reference.
|
- [API.md](docs/API.md) - Implemented WebSocket and REST API reference.
|
||||||
- [DEPLOYMENT.md](DEPLOYMENT.md) - Production deployment and operations guide.
|
- [DEPLOYMENT.md](docs/DEPLOYMENT.md) - Production deployment and operations guide.
|
||||||
- [MONITORING.md](MONITORING.md) - Prometheus and Grafana setup and troubleshooting.
|
- [MONITORING.md](docs/MONITORING.md) - Prometheus and Grafana setup and troubleshooting.
|
||||||
- [SECURITY.md](SECURITY.md) - Security controls, hardening checklist, and incident baseline.
|
- [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.
|
- [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.
|
- [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).
|
- [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)
|
[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.
|
||||||
File renamed without changes.
@@ -135,7 +135,7 @@ See .env.example and SETUP.md for full variable reference.
|
|||||||
|
|
||||||
## Pull-and-Run Deployment
|
## Pull-and-Run Deployment
|
||||||
|
|
||||||
Images are built and pushed automatically by the CI and release workflows (see [CONTRIBUTING.md](CONTRIBUTING.md#versioning-and-releases) for the release procedure).
|
Images are built and pushed automatically by the CI and release workflows (see [CONTRIBUTING.md](../CONTRIBUTING.md#versioning-and-releases) for the release procedure).
|
||||||
|
|
||||||
Every push to `main` triggers CI (builds `:main` and `:latest` tags) and CD (deploys `:latest` to test lab) in parallel. Semantic version tags (`*.*.*`, e.g. `1.0.9`) trigger the release workflow which builds `:X.Y.Z`, `:X.Y`, and `:latest` tags and creates a Gitea Release.
|
Every push to `main` triggers CI (builds `:main` and `:latest` tags) and CD (deploys `:latest` to test lab) in parallel. Semantic version tags (`*.*.*`, e.g. `1.0.9`) trigger the release workflow which builds `:X.Y.Z`, `:X.Y`, and `:latest` tags and creates a Gitea Release.
|
||||||
|
|
||||||
@@ -1,7 +1,5 @@
|
|||||||
# DEVELOPMENT.md — Linear Void Remaining Tasks
|
# DEVELOPMENT.md — Linear Void Remaining Tasks
|
||||||
|
|
||||||
> Auto-generated 2026-08-07. All completed items moved to `.github/instructions/DONE.md`.
|
|
||||||
|
|
||||||
## Test Fixtures (BLOCKED — requires ffmpeg)
|
## Test Fixtures (BLOCKED — requires ffmpeg)
|
||||||
|
|
||||||
- [ ] Create test media fixtures in `backend/playout/testdata/`:
|
- [ ] Create test media fixtures in `backend/playout/testdata/`:
|
||||||
File renamed without changes.
@@ -0,0 +1,41 @@
|
|||||||
|
# Docs Folder
|
||||||
|
|
||||||
|
This folder contains the documentation for the Linear Void project. The documentation is organized into several markdown files, each covering different aspects of the project.
|
||||||
|
|
||||||
|
## Architecture
|
||||||
|
|
||||||
|
- [Architecture](architecture/README.md) - High-level system architecture and component interactions.
|
||||||
|
|
||||||
|
## API
|
||||||
|
|
||||||
|
- [API](API.md) - Implemented WebSocket and REST API reference.
|
||||||
|
|
||||||
|
## Deployment
|
||||||
|
|
||||||
|
- [Deployment](DEPLOYMENT.md) - Production deployment and operational runbook.
|
||||||
|
|
||||||
|
## Monitoring
|
||||||
|
|
||||||
|
- [Monitoring](MONITORING.md) - Metrics, dashboards, and monitoring troubleshooting.
|
||||||
|
|
||||||
|
## Security
|
||||||
|
|
||||||
|
- [Security](SECURITY.md) - Security model, controls, and hardening baseline.
|
||||||
|
|
||||||
|
## Setup
|
||||||
|
|
||||||
|
- [Setup](SETUP.md) - Test lab setup, local development, and CI/CD workflow.
|
||||||
|
|
||||||
|
## Streaming
|
||||||
|
|
||||||
|
- [Streaming](STREAMING.md) - Streaming architecture, playout, and delivery details.
|
||||||
|
|
||||||
|
## Development
|
||||||
|
|
||||||
|
- [Development](DEVELOPMENT.md) - Remaining tasks and test fixtures for development.
|
||||||
|
|
||||||
|
## Additional Resources
|
||||||
|
|
||||||
|
- [Marketing](marketing/README.md) - Marketing materials and resources.
|
||||||
|
- [Operations](operations/README.md) - Operational procedures and checklists.
|
||||||
|
- [Incident Runbook](incident-runbook.md) - Incident response and disaster recovery procedures.
|
||||||
File renamed without changes.
File renamed without changes.
File renamed without changes.
@@ -87,10 +87,12 @@
|
|||||||
|
|
||||||
## Companion Documentation
|
## Companion Documentation
|
||||||
|
|
||||||
- [API.md](../../API.md) - Implemented WebSocket and REST API reference.
|
- [API.md](../API.md) - Implemented WebSocket and REST API reference.
|
||||||
- [DEPLOYMENT.md](../../DEPLOYMENT.md) - Production deployment and operational runbook.
|
- [DEPLOYMENT.md](../DEPLOYMENT.md) - Production deployment and operational runbook.
|
||||||
- [MONITORING.md](../../MONITORING.md) - Metrics, dashboards, and monitoring troubleshooting.
|
- [MONITORING.md](../MONITORING.md) - Metrics, dashboards, and monitoring troubleshooting.
|
||||||
- [SECURITY.md](../../SECURITY.md) - Security model, controls, and hardening baseline.
|
- [SECURITY.md](../SECURITY.md) - Security model, controls, and hardening baseline.
|
||||||
|
- [SETUP.md](../SETUP.md) - Test lab setup, local development, and CI/CD workflow.
|
||||||
|
- [STREAMING.md](../STREAMING.md) - Streaming architecture, playout, and delivery details.
|
||||||
|
|
||||||
## Introduction and Goals
|
## Introduction and Goals
|
||||||
|
|
||||||
|
|||||||
Reference in new issue
Block a user