Files

T

enricobuehler 5cd6e8f572 docs: reflect the plugin-runner security tiers

- plugins: the Windows runner task runs as LocalService now, and
  public-registry names need --allow-public-registry
- automation + SDK README: connect()'s zero-config credential is the
  scoped plugin token; pairing administration and hook registration
  need an explicit PUNKTFUNK_MGMT_TOKEN opt-in

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

2026-07-20 00:45:27 +02:00

content/docs

docs: reflect the plugin-runner security tiers

2026-07-20 00:45:27 +02:00

public

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

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

src

feat(plugins): punktfunk-host plugins CLI — add/remove/list/enable/disable/status

2026-07-19 16:34:43 +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

refactor(docs): use shared @unom/app-ui/footer component

2026-06-28 14:34:45 +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

refactor(docs): use shared @unom/app-ui/footer component

2026-06-28 14:34:45 +00:00

README.md

docs: repo-wide housekeeping — sync README & docs with the code as shipped

2026-07-10 09:13:42 +02: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. 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 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