Getting Started

Purpose

The docs/ directory is a Markdown-first documentation site powered by VitePress. Content lives in .md files, while the site shell and build process come from the Node project in the same directory.

Local Workflow

From the repository root:

cd docs
npm install
npm run dev

For a production build:

cd docs
npm run build

Why This Exists

This setup makes the future docs-build CI job meaningful:

• npm ci installs the exact locked dependency graph from package-lock.json
• npm run build verifies the Markdown docs still compile into a static site

Writing Docs

Add new pages as Markdown files under these sections:

• guide/ for onboarding and how-to material
• architecture/ for system design and request flow
• reference/ for code maps and operational details

Then register important new pages in .vitepress/config.mts so they appear in the navigation and sidebar.