pal-e-docs-app: Dev environment with hot-reload overlay #344

Closed
opened 2026-05-05 04:07:44 +00:00 by forgejo_admin · 0 comments
Contributor

Type

Feature

Lineage

Standalone — scoped during platform SSO initiative (2026-05-04). Depends on playground Keycloak gating.

Repo

forgejo_admin/pal-e-deployments + new repo forgejo_admin/pal-e-docs-app

User Story

As a platform admin
I want a SvelteKit dev environment for pal-e-docs frontend
So that I can iterate on my documentation system's UI with live hot-reload

Context

pal-e-docs has an API (api.pal-e-docs.tail5b443a.ts.net) but no frontend app. This ticket creates the SvelteKit frontend repo and a dev overlay with hostPath volume mount for live iteration. This is where Lucas builds the interface to interact with his documentation system (notes, boards, blocks, search).

Follows the pipeline: playground (CSS/layout) → svelte app (live data) → production. The dev overlay gives immediate feedback while developing.

File Targets

Files the agent should modify or create:

  • New repo: pal-e-docs-app/ with SvelteKit scaffold
  • overlays/pal-e-docs-app/dev/ — hostPath deployment + ingress in pal-e-deployments

Files the agent should NOT touch:

  • pal-e-docs/ (the API repo) — frontend is separate
  • pal-e-playground/ — hub repo is CSS guide only

Acceptance Criteria

  • pal-e-docs-app repo scaffolded with SvelteKit
  • Dev overlay deployed with hostPath to ~/pal-e-docs-app
  • Accessible at a Tailscale funnel hostname (e.g., pal-e-docs-dev.tail5b443a.ts.net)
  • Keycloak-gated (platform realm SSO)
  • Hot-reload works: edit file on host, see change in browser
  • Can fetch from pal-e-docs API (api.pal-e-docs.tail5b443a.ts.net)

Test Expectations

  • Build passes: npm run build
  • Dev server starts: npm run dev -- --host
  • API connectivity: fetch notes list from pal-e-docs API
  • Run command: npm run build

Constraints

  • Same CSS convention (design tokens, Atkinson Hyperlegible, no Tailwind)
  • Use @auth/sveltekit for Keycloak OIDC
  • Dev overlay follows pal-e-hub/dev pattern (node:22, hostPath, emptyDir node_modules)
  • Must be able to reach pal-e-docs API (internal cluster DNS or public funnel)

Checklist

  • PR opened
  • Tests pass
  • No unrelated changes
  • project-pal-e-platform — platform project
  • project-pal-e-docs — docs system
### Type Feature ### Lineage Standalone — scoped during platform SSO initiative (2026-05-04). Depends on playground Keycloak gating. ### Repo `forgejo_admin/pal-e-deployments` + new repo `forgejo_admin/pal-e-docs-app` ### User Story As a platform admin I want a SvelteKit dev environment for pal-e-docs frontend So that I can iterate on my documentation system's UI with live hot-reload ### Context pal-e-docs has an API (`api.pal-e-docs.tail5b443a.ts.net`) but no frontend app. This ticket creates the SvelteKit frontend repo and a dev overlay with hostPath volume mount for live iteration. This is where Lucas builds the interface to interact with his documentation system (notes, boards, blocks, search). Follows the pipeline: playground (CSS/layout) → svelte app (live data) → production. The dev overlay gives immediate feedback while developing. ### File Targets Files the agent should modify or create: - New repo: `pal-e-docs-app/` with SvelteKit scaffold - `overlays/pal-e-docs-app/dev/` — hostPath deployment + ingress in pal-e-deployments Files the agent should NOT touch: - `pal-e-docs/` (the API repo) — frontend is separate - `pal-e-playground/` — hub repo is CSS guide only ### Acceptance Criteria - [ ] `pal-e-docs-app` repo scaffolded with SvelteKit - [ ] Dev overlay deployed with hostPath to `~/pal-e-docs-app` - [ ] Accessible at a Tailscale funnel hostname (e.g., `pal-e-docs-dev.tail5b443a.ts.net`) - [ ] Keycloak-gated (platform realm SSO) - [ ] Hot-reload works: edit file on host, see change in browser - [ ] Can fetch from pal-e-docs API (`api.pal-e-docs.tail5b443a.ts.net`) ### Test Expectations - [ ] Build passes: `npm run build` - [ ] Dev server starts: `npm run dev -- --host` - [ ] API connectivity: fetch notes list from pal-e-docs API - Run command: `npm run build` ### Constraints - Same CSS convention (design tokens, Atkinson Hyperlegible, no Tailwind) - Use @auth/sveltekit for Keycloak OIDC - Dev overlay follows pal-e-hub/dev pattern (node:22, hostPath, emptyDir node_modules) - Must be able to reach pal-e-docs API (internal cluster DNS or public funnel) ### Checklist - [ ] PR opened - [ ] Tests pass - [ ] No unrelated changes ### Related - `project-pal-e-platform` — platform project - `project-pal-e-docs` — docs system
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
ldraney/pal-e-platform#344
No description provided.