Files

T

enricobuehler f6490f4c28 fix: complete the docs/→design/ and openapi→api/ rename references

The file moves (docs/ → design/, docs/api/openapi.json → api/openapi.json) landed
in d01a8fd, but the matching reference updates did not — so mgmt.rs's drift-test
`include_str!("../../../docs/api/openapi.json")` pointed at a path that no longer
exists and the host failed to build. This restores it and updates every reference:

  - mgmt.rs include_str! → ../../../api/openapi.json (fixes the build)
  - web/orval.config.ts codegen target, web/Dockerfile, .dockerignore
  - deb/rpm/Arch packaging install paths
  - CLAUDE.md, the .gitea CI workflows, code doc-comments, design-doc cross-links

docs-site route URLs (/docs/...) untouched.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

2026-06-26 11:53:02 +00:00

content/docs

feat(android): native mDNS discovery, host naming, touch mouse, stock selects

2026-06-22 23:48:45 +02:00

public

feat(web): unify console + docs on @unom/ui; host OpenAPI via Scalar

2026-06-21 12:00:46 +00:00

src

fix theme

2026-06-26 06:20:21 +00:00

.dockerignore

feat(ci): Gitea Actions — dockerized web/docs/rust-ci images, Apple client CI, Mac runner

2026-06-12 12:28:13 +00:00

.gitignore

docs(site): Fumadocs documentation site on TanStack Start

2026-06-12 11:17:59 +00:00

bun.lock

fix theme

2026-06-26 06:20:21 +00:00

Dockerfile

feat(ci): Gitea Actions — dockerized web/docs/rust-ci images, Apple client CI, Mac runner

2026-06-12 12:28:13 +00:00

package.json

fix theme

2026-06-26 06:20:21 +00:00

README.md

fix: complete the docs/→design/ and openapi→api/ rename references

2026-06-26 11:53:02 +00:00

source.config.ts

docs(site): Fumadocs documentation site on TanStack Start

2026-06-12 11:17:59 +00:00

tsconfig.json

docs(site): Fumadocs documentation site on TanStack Start

2026-06-12 11:17:59 +00:00

vite.config.ts

docs(site): Fumadocs documentation site on TanStack Start

2026-06-12 11:17:59 +00:00

README.md

punktfunk-docs

The punktfunk documentation site: Fumadocs on TanStack Start (Vite + Nitro/bun preset).

Content lives in 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 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