Zum Hauptinhalt springen

Operations (docs site)

How this documentation site itself is built and rolled out. This is for people who publish docs — not required reading to integrate the SDK.

Local​

npm run portal:install
npm run portal:build # docusaurus build + manifest
npm run portal:serve # http://127.0.0.1:3400/dic-docs/

Staging host​

ItemValue
URLhttps://dicdoc.projects-a.plygrnd.tech/dic-docs/
Coolify appdic-developer-portal
Run serverprojects-01
Build serverbuild
Dockerfile/docs/portal/Dockerfile (repo root as context)

/ on the host redirects to /dic-docs/.

Auth gate​

The static site can later sit behind HTTP basic auth or an identity-aware proxy. That gate is optional and separate from Control Plane auth for APIs. Until enabled, treat staging docs as internal-only by convention.

Rollback​

Redeploy the previous image tag from the registry (registry.plygrnd.tech/msqdx/dic-developer-portal:<git-sha>). The manifest’s docsCommit tells you which HTML tree you are looking at.

Quality gates​

CI workflow dic-developer-portal builds the site, syncs OpenAPI/SDL into static/artifacts, and runs inventory/site Vitest checks.