GitBook-ready documentation for building, publishing and profiling games on Vapour.
Canonical handbook: https://vapour-dev-docs.pages.dev/
Repository chapters · Implementation status · Tutorials
The handbook covers the CLI, tokens, engine exports, publishing, CI, local development, deployment, browser telemetry, native profiling, traces and analysis. It documents the source available on 14 October 2026 and explicitly labels unreleased workflows. It does not imply that preview features are deployed.
gitbook-docs.yaml defines the site mapping. book/.gitbook.yaml and
book/SUMMARY.md define the space and navigation. The root .gitbook.yaml
also supports a single-space Git Sync setup.
Follow Connect this repository to GitBook to authorize GitHub Sync and publish a site. No GitBook account credentials are stored here.
Step-by-step walkthroughs for Godot, Bevy and
Unity, plus local profiling. Each uses a sample project
forked into the vapour-computer organization (branch vapour-tutorial). Every page says what was verified and what was not.
.github/workflows/pages.yml deploys the book on every push to main. Enable it once under
Settings → Pages → Source: GitHub Actions. The site is then at https://<owner>.github.io/<repository>/.
The build also writes llms.txt, llms-full.txt, sitemap.xml and a Markdown copy of every page under md/. See
use this handbook with an AI assistant.
Use the maintained HonKit builder on Node 22:
npm ci
npm run buildCloudflare settings: framework preset None, build command npm run build,
output directory _book, repository root, production branch main.
The build validates every generated page and local link. See the
Cloudflare Pages guide.
gitbook-cli is the obsolete legacy builder and crashes on current Node versions.
GitBook's hosted service uses Git Sync; this static hosting path uses HonKit.
python3 scripts/check_docs.pyRead CONTRIBUTING.md before editing implementation claims.