Files
punktfunk/docs-site
enricobuehler 1436c0b9b4
ci / web (push) Successful in 48s
ci / bench (push) Successful in 5m54s
docker / build-push (ci, ci/rust-ci-noble.Dockerfile, punktfunk-rust-ci-noble) (push) Successful in 9s
ci / docs-site (push) Successful in 57s
apple / swift (push) Successful in 1m14s
docker / build-push (ci, ci/rust-ci.Dockerfile, punktfunk-rust-ci) (push) Successful in 8s
decky / build-publish (push) Successful in 18s
docker / build-push (docs-site, docs-site/Dockerfile, punktfunk-docs) (push) Successful in 46s
docker / build-push (--build-arg FEDORA_VERSION=44, ci, ci/fedora-rpm.Dockerfile, punktfunk-fedora44-rpm) (push) Successful in 9s
apple / screenshots (push) Successful in 6m7s
docker / build-push (., web/Dockerfile, punktfunk-web) (push) Successful in 8s
deb / build-publish (push) Successful in 9m34s
windows-msix / package (arm64, C:\Users\Public\ffmpeg-arm64, --no-default-features, aarch64-pc-windows-msvc, C:\t-a64) (push) Successful in 6m35s
docker / build-push (ci, ci/fedora-rpm.Dockerfile, punktfunk-fedora-rpm) (push) Successful in 9s
flatpak / build-publish (push) Failing after 8m3s
docker / deploy-docs (push) Successful in 27s
arch / build-publish (push) Successful in 11m45s
deb / build-publish-host (push) Successful in 12m2s
android / android (push) Successful in 16m10s
windows-msix / package (x64, C:\Users\Public\ffmpeg, , x86_64-pc-windows-msvc, C:\t) (push) Successful in 6m50s
rpm / build-publish (43, bazzite, punktfunk-fedora-rpm) (push) Successful in 14m39s
ci / rust (push) Successful in 23m19s
rpm / build-publish (44, fedora-44, punktfunk-fedora44-rpm) (push) Successful in 14m5s
windows / build (aarch64-pc-windows-msvc) (push) Successful in 8m13s
windows / build (x86_64-pc-windows-msvc) (push) Successful in 9m6s
docs(status): Windows HDR10 present validated on glass (Intel D3D11VA pass-through)
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-07-19 14:31:34 +02:00
..

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

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