forked from unom/punktfunk
enricobuehlerandClaude Fable 5
ef39050dbc
Six parallel audits swept the root docs, docs-site, every per-directory README, and the packaging docs; every claim below was verified against the source before editing. - README: Layout gains the six missing crates (pf-client-core, pf-presenter, pf-console-ui, pf-ffvk, pf-driver-proto, punktfunk-tray), clients/session, api/ and ci/; Linux/Windows client rows reflect the shell + Vulkan-session split and the Vulkan Video -> VAAPI/D3D11VA -> software decode chains; the "every client over a C ABI" claim is corrected (Rust clients link the core directly); tiered stats overlay + console shell noted; Apple row mentions AV1. - CONTRIBUTING: drop the dead CLAUDE.md link (deliberately untracked); point at the README's build/invariants sections. SECURITY: 0.9.0. - host-cli/pairing: --allow-pairing/--require-pairing are no-op legacy names — pairing is required by default, --allow-tofu is the real flag; document --data-port and --idle-timeout-ms. - configuration: document PUNKTFUNK_RECOVER_SESSION_CMD (session-crash recovery hook), PUNKTFUNK_MDNS, PUNKTFUNK_DATA_PORT. - virtual-displays/gnome: GNOME per-client scaling shipped (host- persisted) — flip the ❌ to ✅ and describe how it works. - stats: new "Detail levels" section (Off/Compact/Normal/Detailed + per-platform cycle gestures); retire the GTK hand-off note. - clients/install-client/status/roadmap: decode chains, Windows client validation narrowed to HDR-only pending, adaptive bitrate, console shell, Apple AV1, Windows host vendor list. - Sub-READMEs: clients/linux rewritten for the re-architecture; session Windows decode rung + d3d11va knob; Windows tiered overlay; Android minSdk 28; decky file table; host zerocopy/ path; scripts port 47992 and steamos-host.md; pf-dualsense source path. - packaging: canary version bases are tag-derived (<next-minor> via pf-version.sh/.ps1), codecs-extra not ffmpeg-full, document the pinned offline-Skia tarball + SKIA_BINARIES_URL and vulkan-headers. - Convert 15 dangling design/*.md links to the punktfunk-planning prose convention (those docs live in the private planning repo). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
53 lines
1.7 KiB
Markdown
53 lines
1.7 KiB
Markdown
# punktfunk-docs
|
|
|
|
The punktfunk documentation site: [Fumadocs](https://fumadocs.dev) on
|
|
[TanStack Start](https://tanstack.com/start) (Vite + Nitro/bun preset).
|
|
|
|
Content lives in [`content/docs/`](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](https://github.com/scalar/scalar) reference (linked from the top nav, the docs
|
|
sidebar, and the landing page). It reads [`public/openapi.json`](public/openapi.json) — a
|
|
**snapshot** of the repo's generated spec. Refresh it after a management-API change:
|
|
|
|
```sh
|
|
# 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
|
|
|
|
```sh
|
|
bun install
|
|
bun run dev # http://localhost:3001 (docs at /docs)
|
|
```
|
|
|
|
## Build & serve
|
|
|
|
```sh
|
|
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
|
|
```
|