The page claimed "audio is a fraction of a percent of a stream's bandwidth, so high costs
nothing worth counting". At 256 kbps plus redundancy that is 512 kbps — true of a 20 Mbps
session, wrong by an order of magnitude on a 5 Mbps one, which is why the budget now exists.
Says what actually happens on a narrow link, and points at the log line that reports the
settled tier.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

2026-08-04 17:58:39 +02:00

content/docs

docs(troubleshooting): the audio quality knobs are a request, not a guarantee

2026-08-04 17:58:39 +02:00

public

feat(core): every connect introduces the device by name

2026-07-29 21:32:50 +02:00

src

feat(plugins): punktfunk-host plugins CLI — add/remove/list/enable/disable/status

2026-07-19 16:34:43 +02:00

.dockerignore

feat(ci): Gitea Actions — dockerized web/docs/rust-ci images, Apple client CI, Mac runner

2026-06-12 12:28:13 +00:00

.gitignore

docs(site): Fumadocs documentation site on TanStack Start

2026-06-12 11:17:59 +00:00

bun.lock

refactor(docs): use shared @unom/app-ui/footer component

2026-06-28 14:34:45 +00:00

Dockerfile

feat(ci): Gitea Actions — dockerized web/docs/rust-ci images, Apple client CI, Mac runner

2026-06-12 12:28:13 +00:00

package.json

refactor(docs): use shared @unom/app-ui/footer component

2026-06-28 14:34:45 +00:00

README.md

docs: the docs catch up with five releases of shipped work

2026-07-31 17:37:06 +02:00

source.config.ts

docs(site): Fumadocs documentation site on TanStack Start

2026-06-12 11:17:59 +00:00

tsconfig.json

docs(site): Fumadocs documentation site on TanStack Start

2026-06-12 11:17:59 +00:00

vite.config.ts

docs(site): Fumadocs documentation site on TanStack Start

2026-06-12 11:17:59 +00:00

README.md

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.

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

Nothing in CI diffs the two, so the snapshot goes stale silently — that manual cp is the only thing keeping them in sync. Before publishing docs, check that they match:

diff <(jq -S . api/openapi.json) <(jq -S . docs-site/public/openapi.json)

That should print nothing. Right now it doesn't: the committed snapshot predates the /api/v1/update/check, /api/v1/update/apply and /api/v1/update/status endpoints, so the published /api reference is missing the host self-update surface — re-copy it.

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