mirror of
git://f0xx.org/android_cast
synced 2026-07-29 08:19:00 +03:00
Android Cast — documentation index
Click a link to open a guide. Section links jump within the document (GitHub, Cursor, and most Markdown previews).
Table of contents
All documents
| Document | Summary |
|---|---|
| 20260602_REVERSE_SSH_proposals_summary.md | On-demand remote access (WG/SSH/file API) proposals. |
| ALPHA.md | Alpha feature freeze, QA sign-off, defaults. |
| ALPHA_SOAK.md | Short LAN soak checklist for demo validation. |
| AV_QUALITY_QA_SESSION.md | AV enhancement Q&A: sender vs receiver pipelines. |
| BUILD_DEPLOY.md | Docker CI, staging OTA, builder console deploy. |
| COMMERCIAL.md | Developer-gated ads / IAP toggles. |
| CRASH_REPORTER.md | Anonymous crash upload (app + backend). |
| GIT_FLOW.md | Branches (master / next), release, hotfix, dual remote. |
| GRAFANA_vs_others_graphvis_pivot.md | Custom graphs vs Grafana decision memo. |
| INFRA.md | Production topology: Gentoo FE → Alpine BE, ports, nginx, sshfs. |
| OPEN_API.md | Crash ingest API design, triage tags, heuristics. |
| OPUS_SPEEX_VALIDATION.md | Opus/Speex + UDP stream protection E2E checklist. |
| OTA.md | OTA channel layout v0, manifests, MQTT, publish flow. |
| PRO_AAR.md | cast-core / cast-pro AAR split and Play Billing. |
| REMOTE_ACCESS_IMPL.md | WireGuard v1 impl + deploy |
| REMOTE_ACCESS_VALIDATION.md | Linux CLI suite + mobile parity |
| ROADMAP.md | Implementation roadmap, alpha definition, deferred work. |
| TICKETS_ROADMAP.md | Tickets console, Gitea, attachments, agent queue. |
| USB_HDMI_CAST.md | Roadmap D/E: HDMI awareness, USB-tether transport. |
By topic
Infrastructure and deploy
- INFRA.md — FE/BE topology, nginx, ports (§1 Topology)
- BUILD_DEPLOY.md — Docker CI, builder (§Docker CI)
- OTA.md — OTA v0 layout (§URL layout)
Development process
- GIT_FLOW.md —
master/next(§2 Branches) - ROADMAP.md — milestones (§Alpha definition)
Alpha and QA
- ALPHA.md — freeze and sign-off (§Alpha scope)
- ALPHA_SOAK.md — LAN soak (§Happy path)
Backend apps
- CRASH_REPORTER.md — crash upload
- OPEN_API.md — ingest API (§Upload API)
- TICKETS_ROADMAP.md — tickets + Gitea
- GRAFANA_vs_others_graphvis_pivot.md — graphs pivot
- 20260602_REVERSE_SSH_proposals_summary.md — remote access (§Rev. 3 Q&A)
Product and codecs
- COMMERCIAL.md — ads / IAP
- PRO_AAR.md — Pro AAR split
- USB_HDMI_CAST.md — HDMI / USB-tether
- AV_QUALITY_QA_SESSION.md — AV enhancement Q&A
- OPUS_SPEEX_VALIDATION.md — codec + FEC/NACK field matrix (§E2E matrix)
Agent bootstrap
After a context reset, read in order:
- INFRA.md — topology (no
:8089for androidcast) - GIT_FLOW.md — branch rules
- Task-specific: BUILD_DEPLOY.md, TICKETS_ROADMAP.md, 20260602_REVERSE_SSH_proposals_summary.md, etc.
Repo root AGENTS.md points here.
Maintaining TOCs
Section links use GitHub/Cursor-style heading anchors. After adding or renaming ## / ### headings, run:
python3 scripts/generate-docs-toc.py