Files

T

enricobuehler 5a38a6723e docs(roadmap): add surround & spatial (object) audio plan

Near-term 7.1 channel bed; moonshot object-based spatial audio via
Wine/Proton (where dynamic objects are currently discarded) with
client-side head-tracked spatialization.

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

2026-06-22 15:24:12 +00:00

content/docs

docs(roadmap): add surround & spatial (object) audio plan

2026-06-22 15:24:12 +00:00

public

feat(web): unify console + docs on @unom/ui; host OpenAPI via Scalar

2026-06-21 12:00:46 +00:00

src

fix(docs): stop Scalar's global body bg from bleeding into the docs on client-nav

2026-06-21 18:49:20 +00: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

feat(web): unify console + docs on @unom/ui; host OpenAPI via Scalar

2026-06-21 12:00:46 +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

feat(web): unify console + docs on @unom/ui; host OpenAPI via Scalar

2026-06-21 12:00:46 +00:00

README.md

feat(web): unify console + docs on @unom/ui; host OpenAPI via Scalar

2026-06-21 12:00:46 +00: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. Several pages are imported verbatim from the repo's docs/ design notes (with added frontmatter); edit those there or here as the docs site becomes the source of truth.

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 > docs/api/openapi.json
cp docs/api/openapi.json docs-site/public/openapi.json

Develop

bun install
bun run dev        # http://localhost:3001  (docs at /docs)

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