Skip to main content

Develop the Documentation Site Locally

This page is for repository maintainers and contributors. It is not a customer self-hosting or production deployment guide.

Prerequisites and package​

Use Node.js 18 or later and npm. The Docusaurus package is:

sol-chat-mkt/sol-chat-mkt/sol-docs

Application sources referenced by documentation live beside it in sol-app; the browser widget package is at the workspace-level sol-chat-embed.

Install and run​

cd sol-chat-mkt/sol-chat-mkt/sol-docs
npm install
npm run start -- --port 3001

Do not place production secrets in .env, Markdown examples, or generated output merely to run the docs site.

Validate a change​

npm run generate:references
npm run check:docs
npm run build
npm run serve

generate:references updates deterministic plan and RBAC data from the application source. check:docs validates metadata, headings, internal links, and generated drift. The production build also rejects broken Docusaurus links.

If the update checker cannot write to a user-level config directory, the static build can still succeed; do not change system permissions as part of a docs content change.