enricobuehler
9c278ee351
Static content used to strip every defense before motion: the unpaced microburst allowance was an absolute max(128 KiB, wire/4) — sized for gigabit LAN, so at Wi-Fi bitrates every frame went out back-to-back — and adaptive FEC decayed to 1 %, so the first big motion frame died unprotected (the 2026-08-26 field case; RFC design/abr-stack-overhaul.md in punktfunk-planning, §2.1–2.4). - The allowance is now TIME at the pace rate: 10 ms, clamped to [16 KiB, 256 KiB] (send_pacing::auto_burst_bytes). One constant lines up both proven ends — ~19 KiB at the field case's 15 Mbps pace (its discriminator was PACE_BURST_KB=16) and ~112 KiB at 90 Mbps LAN pace, so LAN latency does not regress. PACE_FACTOR=0 keeps the legacy rule. - A streamed AU consumes ONE allowance across its block flushes instead of a fresh one per block (the latent per-block multiplication). - One frame's paced spread is bounded to ~2 frame intervals so an IDR can't back the encode|send sync_channel(3) up into cadence_degraded, which refuses every climb; MAX_PACE_SPREAD stays the absolute bound. - Adaptive FEC gains a burned floor: any window with real shard loss raises the decay floor to 5 %; ~2 clean minutes re-earn 1 %, an early re-burn doubles the requirement (bounded), a durable step-down resets it — no session-permanent latch, per the encode stand-down's house rule. PUNKTFUNK_FEC_PCT pin semantics and the GameStream plane are untouched. Pure logic (FecFloor, auto_burst_bytes, native_budget) is unit-tested; the burned-floor band is noted in the FEC_PCT docs.
punktfunk-docs
The Punktfunk documentation site: Fumadocs on TanStack Start (Vite + Nitro/bun preset).
Content lives in content/docs/ as .md/.mdx. This site is the source of truth
for the user-facing guides; design rationale lives in the internal punktfunk-planning repo, and
READMEs and the marketing site link here instead of restating anything — see "Where facts live" in
CONTRIBUTING.md. Pages serve one of two audiences, not both at once: the
get-started track (quickstart, install, pairing) assumes no Linux expertise — short pages, one
task each, happy path only; the reference track (configuration, CLI, API, per-compositor
pages) is allowed to be dense.
API reference
/api renders the host's management REST API as an interactive
Scalar reference (linked from the top nav, the docs
sidebar, and the landing page). It reads public/openapi.json — a
snapshot of the repo's generated spec. Refresh it after a management-API change:
# from the repo root — regenerate the spec, then copy the snapshot in:
cargo run -p punktfunk-host -- openapi > api/openapi.json
cp api/openapi.json docs-site/public/openapi.json
CI keeps the pair honest: the docs-drift job fails unless the snapshot is a byte-for-byte copy
of api/openapi.json, and the rust job regenerates the spec and diffs it against the committed
one — so a management-API change can't publish stale API docs any more, it fails CI until you run
the two commands above.
Install commands and ports
src/data/platforms.json is a byte-identical snapshot of the repo-root
data/platforms.json — the single source for install commands, repo
URLs, port facts and the Sunshine/Apollo/Vibeshine conflict facts. The <Install platform="…" />
and <Ports /> MDX components (src/components/platforms.tsx) render from it, so no page restates
a command or a port. It's a snapshot for the same reason as openapi.json (the Docker build context
is this directory alone), and the same docs-drift job fails unless it matches:
cp data/platforms.json docs-site/src/data/platforms.json # from the repo root, after editing the canonical file
Develop
bun install
bun run dev # http://localhost:3001 (docs at /docs)
CI gates every change on bun run build followed by bun run lint (the TypeScript typecheck), in
that order — the build emits the .source typegen the typecheck imports. Run both before you push.
Build & serve
bun run build
bun run start # serves .output/ via Bun
Layout
source.config.ts Fumadocs MDX collection (content/docs)
content/docs/ the docs content (.md/.mdx) + meta.json nav
src/
routes/
__root.tsx RootProvider + html shell
index.tsx landing page
docs/$.tsx catch-all docs renderer (Fumadocs DocsLayout)
api/index.tsx Scalar API reference (reads public/openapi.json)
api/search.ts Orama search endpoint
lib/source.ts Fumadocs loader over the generated collection
lib/layout.shared.tsx shared nav chrome
components/mdx.tsx MDX component map
styles/app.css Tailwind 4 + Fumadocs preset