Publishing this guide

Manual contents

Source and public home

Edit the Markdown in docs/numlapi. The public home is /common/doc/numl/. The three manuals build together from one command: the NL API User Manual from docs/nlapi to /common/doc/, the SD API User Manual from docs/sdapi to /common/doc/sd/, and this guide from docs/numlapi to /common/doc/numl/. Every page's header links to the other two manuals, and Markdown links of the form ../nlapi/chapter.md or ../sdapi/chapter.md resolve to the other manuals' generated pages (and vice versa).

README renders as index.html; the remaining chapters keep their base names with .html extensions. The build reuses Studio's locally vendored Showdown renderer; the delivered guide needs no JavaScript, CDN, or Markdown server. The stylesheet is the shared common/doc/guide.css, copied beside the generated pages. Generated HTML is a build product, not a second editable copy of the manual. Repository source links point to GitHub's HEAD view.

Configure the header's NuWebKit website destination with websiteUrl in site.json, exactly as for the other manuals.

Build and preview

From the repository root:

npm run build:docs

This writes all three manuals without rebuilding applications. Serve the repository root with your usual local static server, then open /common/doc/numl/. Opening the generated HTML directly also works for reading.

For the complete existing website build and preview:

npm run build:deploy-profile:production
npm run preview:dist

Open http://localhost:8788/common/doc/numl/. The profile builds render the current Markdown of all guides directly into dist/common/doc. The website landing page links to all three manuals.

Validate before publishing

node --test scripts/build-docs.test.mjs scripts/build-dist.test.mjs testing/numlapi-guide.test.mjs

Build checks validate generated pages, local links/anchors, escaping, navigation, and integration into website profiles for all guides. The guide tests execute this manual's NuML programs — the tutorial SIR, the statement-semantics examples, and the lorenz Project.model — against the real compiler and runtime, and check the documented directive and primop vocabularies against the engine's own lists. The sensitivity and stochastic platform pages are browser UI and are exercised manually. Also check a narrow/mobile viewport, keyboard navigation, a long reference table, and a tutorial code block in the browser, and follow the header cross-links among all three manuals.

Deploy with the existing website

Deployment is identical to the other manuals': the existing static website process publishes dist, which contains all three guides. See the NL manual's publishing chapter and the deployment runbook for environment and publication procedures. Verify the landing-page manual links, /common/doc/numl/, the tutorial, a deep heading link, and the cross-links among the manuals on the deployed host. Publishing is a separate operator action; preparing this guide does not authorize or perform an upload.