56 lines
2.1 KiB
Markdown
56 lines
2.1 KiB
Markdown
# 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.
|
|
|
|
## Infrastructure
|
|
|
|
- Cloudflare
|
|
- [Cache Rules](./infrastructure/cloudflare/cache-rules.md) - Cache rules for Cloudflare Workers.
|
|
- [Account Troubleshooting](./infrastructure/cloudflare/cloudflare-account-troubleshooting.md) - Troubleshooting Cloudflare account issues.
|
|
- Monitoring
|
|
- [Prometheus CURL](./infrastructure/monitoring/prometheus_curl.md) - Prometheus metrics endpoint testing with curl and jq. Doocumentation of available metrics and their meanings.
|
|
|
|
## 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.
|
|
|
|
## 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.
|
|
|
|
## Other Documents
|
|
|
|
- [CHANGELOG](../CHANGELOG.md) - Release notes and version history.
|
|
- [CONTRIBUTING](../CONTRIBUTING.md) - Contribution guidelines and code of conduct.
|
|
- [TODO](../.github/instructions/TODO.md) - Active implementation plan with checkboxes.
|
|
- [Backlog](../.github/instructions/BACKLOG.md) - Consolidated list of all development tasks.
|
|
- [Agents](../.github/AGENTS.md) - Instructions for agents and task management.
|
|
- [Memory](../.github/MEMORY.md) - Session memory and development progress tracking.
|
|
- [README](../README.md) - Project overview and high-level information.
|