Pulp Engine Document Rendering

Documentation

Docs are versioned alongside each release. A searchable portal is on the roadmap. In the meantime, here's everything organised by what you're trying to do.

Start here

Evaluator guide

What this is, who it is for, how to run a first trial.

Quick start (file mode)

Docker compose, no database. Up in 60 seconds.

Demo guide

Suggested 15-minute walkthrough for showing the product to a teammate.

For developers

API guide

Every endpoint with examples — render, validate, batch, schedule, admin.

OpenAPI reference

Every endpoint, themed and searchable. Raw JSON available for client generation.

TypeScript SDK

@pulp-engine/sdk on npm. Hand-written, typed.

Python SDK

pulp-engine on PyPI. httpx + Pydantic v2.

.NET SDK

PulpEngine.Sdk on NuGet.

Editor guide

Visual editor capabilities, load/save, preview, known limits.

For operators

Deployment guide

Production hardening, env vars, posture checks.

HA reference architecture

Compose file, nginx upstream, multi-instance considerations.

Backup & restore runbook

CLI-driven backup, verification, restore procedure.

Tenant isolation guarantees

What multi-tenant mode does and does not isolate.

OIDC / SSO

PKCE flow, provider configuration, embed code-exchange.

Data residency & GDPR

Storage location, retention, erasure-by-actor.

Support & release policy

Response targets per tier, release cadence, founding-rate guarantee, what is out of scope today.

Benchmark pack

Seven-cell render benchmark on a documented rig. Reproducible harness ships in the repo for re-running on your own hardware.

Embedding

Embed integration

<pulp-engine-editor> custom element, CSP, EMBED_ALLOWED_ORIGINS.

Embedding guide

Full walkthrough for shipping the editor inside your own product.

Architecture & spec

Technical specification

Template model, rendering pipeline, AST node types.

MVP scope

What is in v1, what is deliberately out.

Release notes

Every published version, chronological and themed. Rendered inline from the repo.

Need a Swagger UI?

Run the file-mode quick start and Pulp Engine serves Swagger UI at /docs out of the box.