Skip to main content

Docs Tooling

The docs site lives in docs/docusaurus. Use this page when you only need the docs toolchain, not the backend/frontend product stack.

Requirements​

  • Node.js 20+
  • npm
  • Access to the repository checkout

Confirm the versions:

node --version
npm --version

Install dependencies​

make docs-install

Direct npm usage works too:

cd docs/docusaurus
npm install

Run the development server​

make docs-dev

The local URL is:

http://localhost:3000/

Build for production​

make docs-build

This writes the static output to docs/docusaurus/build.

Preview the built site​

make docs-serve

When to use this page​

  • You are editing docs content, styling, or structure only.
  • You want to validate the GitHub Pages output locally.
  • You do not need the backend or frontend product stack running.

Need the actual repo setup flow, current env names, GCP notes, or GitHub Pages deployment steps? Use the main Setup Guide.