Skip to content

Publish the documentation site

The platform’s documentation is a Nimbus application deployed through Wrangler, using the same static-assets service as tenant sites. On the default local appliance, open https://ermahgerd-docs.t-bd7662a5eeb4.workers.ermahgerd.localhost:8443.

Build and deploy

make docs-site-deploy
make docs-site-test
make docs-site-browser-check

make up and make examples-deploy include the site. The site consumes the Local Development organization’s Worker and static-assets quotas. No database, provider credential, or special runtime is required.

Edit README.md and the product guides under docs/. The build generates Nimbus pages, converts repository-relative links to site URLs, and copies the screenshots and architecture diagrams. Generated content is not committed; there is only one authored documentation source. Sidebar organization and the Nimbus shell live in examples/ermahgerd-docs/.

To preview locally:

make docs-site-install
cd examples/ermahgerd-docs
npm run dev

The production build includes Pagefind search, refresh-safe page URLs, /llms.txt, and Markdown versions at /<page>/index.md. Search requires a production build; use npm run build && npm run preview to test it locally.

Canonical origin

ERMAHGERD_DOCS_ORIGIN controls absolute URLs in the sitemap, canonical links, social metadata, and machine-readable documentation. It defaults to the local Worker URL. For a future deployment, build with the externally served origin:

ERMAHGERD_DOCS_ORIGIN=https://docs.ermahgerd.io make docs-site-build

This setting does not create DNS records, certificates, or a custom-domain route. Those ingress capabilities must exist before that origin can serve the site. The local appliance is not a public hosting deployment.

Checks

make docs-site-check runs link-transformation tests, Astro type checks, a production build, and Nimbus’s post-build audit. It is included in make checks. make docs-site-test verifies the deployed homepage, deep links, Markdown, discovery, search assets, images, and missing-page behavior without modifying the fleet.

make docs-site-browser-check uses the console’s installed Playwright toolchain to exercise search and mobile navigation, refresh a deep link, and capture both themes. Screenshots are test artifacts under console/test-results/, not a second authored documentation source.

Navigation

Type to search…

↑↓ navigate↵ selectEsc close