Getting started#

The docs website is generated from Markdown files and does not require a hosted CMS. Edit the Markdown source, run the docs build, and deploy the exported static site.

Prerequisites#

• Node.js and npm for the docs website package.
• Python 3 for the production static server script.
• Existing repo tooling for compiling and validating Business Language packages.

Local docs workflow#

cd packages/website-docs.nezam.ai
npm run build
npm run dev

The dev server listens on http://0.0.0.0:7610 by default.

Source locations#

Product and platform documentation:

packages/business/docs/

Business Language documentation:

packages/business/language/

Grammar and compiler assets live under packages/business/language/grammar/ and packages/business/language/scripts/. Markdown files in packages/business/language/ remain public language documentation.

Authoring rules#

• Every page should start with frontmatter containing title, description, order, and section.
• Use fenced code blocks for examples.
• Use declared message examples for user-facing failures.
• Link language pages through /language/.../.

Validation#

Run the package check before deploying:

cd packages/website-docs.nezam.ai
npm run check