android_cast/docs/README.md

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
• Specifications
• Design reviews
• By topic
  • Infrastructure and deploy
  • Development process
  • Alpha and QA
  • Backend apps
  • Product and codecs
• Agent bootstrap
• Maintaining TOCs

---

All documents

Document	Summary
20260602_REVERSE_SSH_proposals_summary.md	On-demand remote access (WG/SSH/file API) proposals.
20260607-2FA-email-mobile-auth-flow.md	Email forwarding + registration/2FA (alpha must-have).
20260608_ALPHA_PRIORITIES.md	Master priority plan (0.1–9.x renumber, owners, alpha path).
20260608_BE_SERVICES_and_infra.md	BE service map, validation status, SFU preview (gray).
20260608_STREAM_DUMP_DEBUG.md	FR 0.1 stream dump spec.
20260610_SERVICES.md	Exposed services catalog — web UI, APIs, curl, validation (2026-06-10).
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.
OPEN_TASKS_GRAPH.md	Open tasks dependency graph (Mermaid).
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.

---

Specifications

Document	Summary
20100611_3_url_shortener.md	URL shortener service — SPEC (s.f0xx.org, post-alpha).
20100612_1_scaling.md	Platform scaling — multi-VM clusters, dev/staging/prod, cloud path (PDF).

---

Design reviews

Document	Summary
20100611_3_url_shortener.md	URL shortener — design review (auth, slug algo, task graph).
20100612_1_scaling.md	Platform scaling — architecture options, RSSH capacity, task graph (PDF).

---

By topic

Infrastructure and deploy

• INFRA.md — FE/BE topology, nginx, ports (§1 Topology)
• specs/20100612_1_scaling.md — scaling SPEC (§6 Target architecture)
• DRs/20100612_1_scaling.md — scaling DR (§15 Task graph)
• 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)
• specs/20100611_3_url_shortener.md — URL shortener SPEC (§REST API)
• DRs/20100611_3_url_shortener.md — URL shortener DR (§Resolved open questions)

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

---

Agent bootstrap

After a context reset, read in order:

1. INFRA.md — topology (no :8089 for androidcast)
2. GIT_FLOW.md — branch rules
3. 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

PDF export (markdown → PDF)

pip install -r docs/_pdf_build/requirements-pdf.txt   # reportlab
bash scripts/build-all-docs-pdf.sh

• Renders every docs/**/*.md to a sibling .pdf (skips drafts/ and _pdf_build/).
• ```mermaid blocks are rendered as PNG diagrams via @mermaid-js/mermaid-cli (needs npx + Chromium); cached under docs/_pdf_build/mermaid_cache/ (gitignored — regenerated on build).
• Dedicated diagram PDFs (pre-built PNGs): build_git_flow_pdf.py, build_graphvis_pivot_pdf.py, etc.