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 - High-level system architecture and component interactions.
Infrastructure
- Cloudflare
- Cache Rules - Cache rules for Cloudflare Workers and Pages.
- Account Troubleshooting - Troubleshooting Cloudflare account issues.
- Monitoring
- Prometheus CURL - Prometheus metrics endpoint testing with curl and jq. Doocumentation of available metrics and their meanings.
API
- API - Implemented WebSocket and REST API reference.
Deployment
- Deployment - Production deployment and operational runbook.
Monitoring
- Monitoring - Metrics, dashboards, and monitoring troubleshooting.
Security
- Security - Security model, controls, and hardening baseline.
Setup
- Setup - Test lab setup, local development, and CI/CD workflow.
Streaming
- Streaming - Streaming architecture, playout, and delivery details.
Additional Resources
- Marketing - Marketing materials and resources.
- Operations - Operational procedures and checklists.
- Incident Runbook - Incident response and disaster recovery procedures.
Other Documents
- CHANGELOG - Release notes and version history.
- CONTRIBUTING - Contribution guidelines and code of conduct.
- TODO - Active implementation plan with checkboxes.
- Backlog - Consolidated list of all development tasks.
- Agents - Instructions for agents and task management.
- Memory - Session memory and development progress tracking.
- README - Project overview and high-level information.