Skip to content
Docs menu

How these docs are built

Build and check the public docs from a venom checkout, serve them from your own Venom Cloud, and read them as markdown, llms.txt or search.json.

View .md

These pages are markdown in the venom repository, under docs/public/<section>/<slug>.md. Venom Cloud renders them when it is built and serves them at /docs. A self-hosted Venom Cloud serves the same docs from its own checkout. Nothing is fetched at build time or when a page loads.

Build and check

cd services/nodejs-cloud
bun run docs                          # build the bundle into .docs-build/bundle.json
node scripts/docs-build.ts --check    # build and report, write nothing

bun run build and bun run dev build the docs first. Under a bare next dev, pages are built in process from the checkout on each reload, so an edit shows right away. A problem stops the build, with the file and the reason on one line. The checks:

  • bad frontmatter (a missing title or description, a section that is not the directory, an unknown key);
  • a broken link or anchor between pages;
  • a code block with no language;
  • an operation, endpoint or route missing from its API reference page.
Variable What it sets Default
VENOM_DOCS_ORIGIN The origin written into canonical URLs, llms.txt, llms-full.txt and the sitemap https://cloud.usevenom.dev
VENOM_DOCS_ROOT The repo checkout the build reads docs/public and the contracts from two levels above services/nodejs-cloud

For agents

URL What
/docs/<section>/<slug>.md a page's markdown, frontmatter included, with links made absolute
/docs/llms.txt one - [title](url.md): description line per page, by section (llmstxt.org format)
/docs/llms-full.txt every page's markdown, in reading order
/docs/search.json the search index the site's search box reads in the browser
/docs/sitemap.xml every docs URL