Skip to content

Publishing the documentation

The documentation website is built from the files in docs/. It is a static site: a folder of HTML, CSS, and JavaScript that any web server can serve. It also holds the playground and the download of AGENTS.md.

The site shows every page of the language reference, the API reference, and this administrator guide, and the file AGENTS.md. It does not show the source code, the plans, the specifications, or docs/decisions.md. Read the administrator guide once before you publish it: it describes how your server is set up, though it holds no secrets.

Terminal window
cargo xtask playground-wasm
pnpm --dir site install --frozen-lockfile
pnpm --dir site build

The result is in site/dist. The playground needs the first command, which builds the engine for the browser (it uses wasm-pack).

The site is built for one address. Two environment variables set it, with these defaults:

Variable Default Meaning
BORNE_DOCS_SITE https://ruanfernandes.github.io The origin of the site
BORNE_DOCS_BASE /borne-engine/ The folder of the site on that origin; use / for a site at the root of its own domain

The repository has a workflow that builds the site and publishes it when a change reaches main. To turn it on, open the repository settings, choose Pages, and set the source to GitHub Actions. A private repository can publish a Pages site on a paid plan or the GitHub Student Pack. The published site is public even when the repository is private.

Pull requests build and check the site and never publish it.

Copy site/dist to any static host and set the two variables above to the address you will use. A custom domain needs nothing more in the site.

Engine version 0.1.0. Built 2026-11-18.