ac/android_cast
1
0
Fork 0
mirror of git://f0xx.org/android_cast synced 2026-07-29 03:38:52 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs update, be sync

Browse Source
This commit is contained in:
Anton Afanasyeu
2026-06-17 14:34:49 +02:00
parent 1ff1753021
commit 5e7ef17c1f
72 changed files with 6460 additions and 3888 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
docs/README.md
View File

@@ -1,5 +1,20 @@
# Android Cast — documentation index
<!-- doc-meta:start -->
| Field | Value |
|---|---|
| Author | Anton Afanasyeu |
| Revision | R1 |
| Creation date | 2026-06-16 |
| Last modification date | 2026-06-16 |
| Co-authored | |
| Severity | medium |
| State | pending review |
| Document type | internal |
<!-- doc-meta:end -->
\newpage
Click a link to open a guide. Section links jump within the document (GitHub, Cursor, and most Markdown previews).
---
@@ -22,6 +37,8 @@ Click a link to open a guide. Section links jump within the document (GitHub, Cu
---
\newpage
## All documents
| Document | Summary |
@@ -51,6 +68,7 @@ Click a link to open a guide. Section links jump within the document (GitHub, Cu
| [ROADMAP.md](ROADMAP.md) | Implementation roadmap, alpha definition, deferred work. |
| [TICKETS_ROADMAP.md](TICKETS_ROADMAP.md) | Tickets console, Gitea, attachments, agent queue. |
| [USB_HDMI_CAST.md](USB_HDMI_CAST.md) | Roadmap D/E: HDMI awareness, USB-tether transport. |
| [VPN_DEMO_GAPS_20260613.md](VPN_DEMO_GAPS_20260613.md) | |
---
@@ -59,7 +77,7 @@ Click a link to open a guide. Section links jump within the document (GitHub, Cu
| Document | Summary |
|----------|---------|
| [20100611_3_url_shortener.md](specs/20100611_3_url_shortener.md) | URL shortener service — SPEC (`s.f0xx.org`, post-alpha). |
| [20100612_1_scaling.md](specs/20100612_1_scaling.md) | Platform scaling — multi-VM clusters, dev/staging/prod, cloud path ([PDF](specs/20100612_1_scaling.pdf)). |
| [20100612_1_scaling.md](specs/20100612_1_scaling.md) | |
---
@@ -68,7 +86,7 @@ Click a link to open a guide. Section links jump within the document (GitHub, Cu
| Document | Summary |
|----------|---------|
| [20100611_3_url_shortener.md](DRs/20100611_3_url_shortener.md) | URL shortener — design review (auth, slug algo, task graph). |
| [20100612_1_scaling.md](DRs/20100612_1_scaling.md) | Platform scaling — architecture options, RSSH capacity, task graph ([PDF](DRs/20100612_1_scaling.pdf)). |
| [20100612_1_scaling.md](DRs/20100612_1_scaling.md) | |
---
@@ -77,8 +95,6 @@ Click a link to open a guide. Section links jump within the document (GitHub, Cu
### Infrastructure and deploy
- [INFRA.md](INFRA.md) — FE/BE topology, nginx, ports ([§1 Topology](INFRA.md#1-topology))
- [specs/20100612_1_scaling.md](specs/20100612_1_scaling.md) — scaling SPEC ([§6 Target architecture](specs/20100612_1_scaling.md#6-target-architecture))
- [DRs/20100612_1_scaling.md](DRs/20100612_1_scaling.md) — scaling DR ([§15 Task graph](DRs/20100612_1_scaling.md#15-task-dependency-graph))
- [BUILD_DEPLOY.md](BUILD_DEPLOY.md) — Docker CI, builder ([§Docker CI](BUILD_DEPLOY.md#docker-ci))
- [OTA.md](OTA.md) — OTA v0 layout ([§URL layout](OTA.md#url-layout))
@@ -131,14 +147,3 @@ Section links use GitHub/Cursor-style heading anchors. After adding or renaming
python3 scripts/generate-docs-toc.py
```
## PDF export (markdown → PDF)
```bash
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.