enricobuehler
78e74f6ceb
Rework the client READMEs to be accurate and inviting to first-time
visitors, and fill in the gaps where crates and tools had none.
- Rewrite clients/{apple,android,decky} READMEs (features-first, trim
dense internal narrative; drop the stale "one session at a time" /
"renegotiation not implemented" section from the Apple README).
- Add READMEs for clients/{linux,windows,probe}, which had none.
- Add crate READMEs for punktfunk-host, punktfunk-core, pf-driver-proto.
- Add brief READMEs for tools/{loss-harness,latency-probe}.
- Fix packaging/README duplicate "Option B" heading (bootc -> Option C).
- Fix docs-site/README stale docs/ -> design/ reference.
- De-stale packaging/windows/drivers/pf-dualsense README (drop "M0 spike"
/ external-checkout framing; reflect in-tree workspace + shipped +
installer-bundled + multi-pad), keeping the driver-authoring lore.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
54 lines
1.7 KiB
Markdown
54 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; repo-internal design rationale lives in
|
|
[`../design/`](../design/README.md).
|
|
|
|
## 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
|
|
```
|