Installation

Requirements

• Node.js 22 or newer (nvm use picks it up from .nvmrc)
• pnpm 12+ (corepack enable picks up the pinned version)
• Git

Steps

git clone https://github.com/hhftechnology/nimbus-docs.git
cd nimbus-docs
pnpm install
pnpm dev

The dev server runs at http://localhost:4321 with hot reload — save a Markdown file and the browser updates in place.

Useful commands

Command	What it does
pnpm dev	local server with HMR
pnpm build	production build into dist/
pnpm preview	serve the built dist/ locally
pnpm check	TypeScript + content-schema validation
pnpm docs:freeze -- 1.9	snapshot the current docs as v1
pnpm deploy	build and deploy to production

Before you open a pull request

pnpm check && pnpm build

CI runs the same two commands plus a link check, so a green local build almost always means a green pull request.