enricobuehler
f3555d5eb5
apple / swift (push) Successful in 55s
ci / web (push) Successful in 45s
ci / docs-site (push) Successful in 1m18s
ci / rust (push) Successful in 4m14s
deb / build-publish (push) Successful in 2m16s
decky / build-publish (push) Successful in 12s
docker / build-push (--build-arg FEDORA_VERSION=44, ci, ci/fedora-rpm.Dockerfile, punktfunk-fedora44-rpm) (push) Successful in 6s
docker / build-push (., web/Dockerfile, punktfunk-web) (push) Successful in 23s
docker / build-push (ci, ci/fedora-rpm.Dockerfile, punktfunk-fedora-rpm) (push) Successful in 3s
ci / bench (push) Successful in 4m40s
docker / build-push (ci, ci/rust-ci.Dockerfile, punktfunk-rust-ci) (push) Successful in 4s
docker / build-push (docs-site, docs-site/Dockerfile, punktfunk-docs) (push) Successful in 46s
rpm / build-publish (bazzite, punktfunk-fedora-rpm) (push) Successful in 8m35s
rpm / build-publish (fedora-44, punktfunk-fedora44-rpm) (push) Successful in 8m18s
docker / deploy-docs (push) Successful in 19s
android / android (push) Successful in 3m12s
Move the management console (web/) off shadcn/ui to the shared @unom/ui design system the marketing site + docs are built on, on the punktfunk violet brand over dark chrome: - Add @unom/ui/@unom/style/motion/radix-ui/zod + Geist; web/.npmrc maps the @unom scope (packages are public-read, so CI needs no npm auth). - styles.css: one dark-violet palette (#141019/#1c1530, brand #6c5bf3 -> #a79ff8) exposed under BOTH the shadcn token names the routes use and @unom/ui's contract, so routes + components both resolve; pulls in @unom/ui's material gloss + easings. - components/ui/* now back onto @unom/ui (AnimatedButton/InputText/Label/ AnimatedCard); brand-mark/wordmark/logo replace the generic Radio icon in the shell + login. - MaterialProvider (specular gloss) at the root. No UI sounds, like the site. docs-site: new /api route renders the host management REST API as an interactive Scalar reference (reads public/openapi.json, a snapshot of docs/api/openapi.json), branded violet and linked from the top nav, the docs sidebar, the landing page, and host-cli.md. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
54 lines
1.8 KiB
Markdown
54 lines
1.8 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`. 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](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 > docs/api/openapi.json
|
|
cp docs/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
|
|
```
|