The offline API and SDK docs site
Build a static, dependency-free docs site from venom's own contracts with make docs-site, for air-gapped networks, and check it with make docs-site-check.
Besides these public docs, a venom checkout can build a static docs site from its own contracts, so it cannot describe an API the code does not have. It is meant for networks with no internet access.
make docs-site # builds dist/docs-site; open dist/docs-site/index.html
make docs-site-check # compares dist/docs-site with the sourcesIt needs python3 3.9 or newer and nothing else: no packages, no network. The output is HTML, one stylesheet and a copy of openapi.yaml, with no scripts, web fonts or CDN, so it opens from disk or any static file server. Light and dark follow the OS.
| Page | Generated from |
|---|---|
| Harness server API | packages/harness-server/openapi.yaml: every operation and schema, anchored as #op-<operationId> and #schema-<Name>, with a curl line each |
| Orchestrator API | the HTTP API section of docs/architecture.md, each endpoint anchored as #ep-<method>-<path> |
| Python client | clients/python/README.md |
| Harness library | docs/build-an-agent-app.md |
| Ports and environment | the shared-contract section of docs/architecture.md |
The build is deterministic: the same sources give byte-identical output, and manifest.json lists every operation and endpoint plus the SHA-256 of the spec it was built from.
Parity check
make docs-site-check reads the sources with plain regular expressions, separately from the build, so a build bug cannot hide. It fails when an operation in openapi.yaml is missing from the site or the site has one the spec lost; when the site was built from an older openapi.yaml; when an endpoint in architecture.md has no anchor or the site lists one the document dropped; or when a page loads anything from elsewhere.
The public docs at /docs use the same anchors in their generated API reference (/docs/api/harness-server, /docs/api/orchestrator), so links work in both.