Files

T

enricobuehler 0be3183cf2 docs: update README + docs site for public readiness

Refresh the README and documentation for public visitors:

- README: public-facing rewrite with accurate status for all four native
  clients (macOS, Linux, Windows, Android) and the Windows host.
- docs site: fix stale client status (Android is a full client, not a
  scaffold; Windows client is stage-1 complete + signed MSIX), add the
  missing Android client section, correct "which client" guidance.
- Windows host: corrected from "deferred/scoped" to implemented & shipping
  (NVIDIA-only, x64-only) across windows-host, roadmap, status,
  requirements, running-as-a-service, and the README.
- Remove internal infrastructure from public docs (box names, private IPs,
  SSH/token commands, deploy topology); rewrite status.md as a public
  project-status page; sanitize ci.md and implementation-plan.md.
- Update clients/android and clients/apple READMEs to current state.

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

2026-06-20 18:59:23 +02:00

content/docs

docs: update README + docs site for public readiness

2026-06-20 18:59:23 +02:00

public

refactor(docs-site): use the vector SVG wordmark instead of the raster

2026-06-20 15:34:19 +02:00

src

feat(docs-site): read footer from the per-tenant CMS collection

2026-06-20 17:11:42 +02: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

feat(docs-site): brand the docs to match the punktfunk website

2026-06-20 14:40:52 +02: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

feat(docs-site): brand the docs to match the punktfunk website

2026-06-20 14:40:52 +02:00

README.md

docs(site): Fumadocs documentation site on TanStack Start

2026-06-12 11:17:59 +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.

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/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