The site builds to static HTML for Cloudflare Pages. Documentation is read from
this repository’s docs/ folder during the build;
generated API content is in lib/api-docs.ts and navigation in lib/docs-catalog.ts.
No engine checkout or sibling directory is required.
Agents can start at /llms.txt, which lists every published page with a link to
its plain Markdown at /markdown/<doc-slug>.md. /llms-full.txt contains the
complete documentation, including generated API references and every language
example. These files are generated from the same catalog and sources as the
HTML pages on each build, so they stay synchronized automatically.
HTML pages advertise their Markdown alternative and the agent index in their
head metadata, and navigation links directly to the agent index.
/robots.txt permits crawling and points to /sitemap.xml.
Canonical URLs use lib/site-url.ts; update it when hosting a fork elsewhere.
Markdown was imported from Engine/docs at engine commit 3db0126b.
This audit checked behavior against engine commit 017db99b7025eeda96acf21967664153a2df0795.
See maintenance for route/link checks and source synchronization.
Engine-local documentation remains in the engine repository; changes affecting published guides and API references must also be made here.
Core scripting examples and lifecycle registration live in lib/api-docs.ts.
Gameplay function examples live in lib/api-example-data.json; lib/api-examples.ts
adds them to the published module pages and search index through lib/docs.ts.
Each entry has an example for all ten script types. Where a language lacks a
getter or needs explicit storage cleanup, document that difference instead of
inventing a call. Check signatures against the engine SDKs when editing examples.
Run npm run check:api-examples to verify language coverage, published calls,
reachable pages, and lifecycle examples. CI runs this check before building.