enricobuehler
50c9db785a
ci / rust (push) Has been cancelled
New standalone app at docs-site/ — Fumadocs (fumadocs-core/ui 16, fumadocs-mdx
15) on TanStack Start (Vite 7 + nitro-v2 bun preset, React 19, Tailwind 4),
mirroring the web/ console stack but with no auth/i18n/orval — docs stay public.
- catch-all docs route (routes/docs/$.tsx), Orama search (routes/api/search.ts),
RootProvider shell, MDX component map, shared nav, custom 404
- content/docs/: hand-written index.mdx + meta.json nav, plus 7 pages imported
from repo docs/ + README (leading H1 stripped, YAML frontmatter added; kept as
.md so existing </{ don't trip MDX JSX). Content is a one-time snapshot.
- mdx() is plugins[0]; tsconfig collections/* -> ./.source/*; SSR search variant;
@source for fumadocs-ui classes. Generated .source/routeTree/dist/.output ignored.
Verified: bun run build (client+SSR+nitro) green, tsc clean, dev + prod servers
serve all routes 200 with SSR content + nav, search returns hits, 404 works.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
22 lines
1.1 KiB
Plaintext
22 lines
1.1 KiB
Plaintext
---
|
|
title: Introduction
|
|
description: Low-latency desktop and game streaming, Linux-first.
|
|
---
|
|
|
|
import { Cards, Card } from 'fumadocs-ui/components/card'
|
|
|
|
**punktfunk** is a ground-up low-latency desktop and game streaming stack, built Linux-first,
|
|
with a shared Rust protocol core (`punktfunk-core`) exposed over a C ABI and native clients per
|
|
platform. It speaks two protocols: GameStream (so a stock Moonlight client just works) and the
|
|
native `punktfunk/1` (QUIC control plane + a hardened UDP data plane with GF(2¹⁶) Leopard FEC and
|
|
AES-GCM).
|
|
|
|
## Start here
|
|
|
|
<Cards>
|
|
<Card title="Project Overview" href="/docs/overview" description="Status, architecture, and milestones at a glance." />
|
|
<Card title="Implementation Plan" href="/docs/implementation-plan" description="The full design: protocol core, milestones, and architecture." />
|
|
<Card title="Roadmap" href="/docs/roadmap" description="Decided next goals and the longer-term bets." />
|
|
<Card title="Linux Host Setup" href="/docs/linux-setup" description="Bring up the build environment on an NVIDIA-GPU Ubuntu VM." />
|
|
</Cards>
|