Docs Site (VitePress)

This folder is both the raw documentation (.md files) and a VitePress site that renders them — Mermaid diagrams, search, and a grouped sidebar — for developers.

Run locally

cd backend/docs
npm install
npm run docs:dev      # http://localhost:5173

Build (what Cloudflare runs)

npm run docs:build    # outputs static site to .vitepress/dist
npm run docs:preview  # serve the built site locally to sanity-check

How it's wired

File	Purpose
.vitepress/config.mjs	Site config: nav, sidebar, Mermaid, local search
index.md	Landing page (VitePress home layout)
writing-guide.md	The doc-writing conventions (was the old index.md)
package.json	Dev dependencies + docs:dev / docs:build / docs:preview scripts

Notes:

• Mermaid is rendered via vitepress-plugin-mermaid.
• .vitepress/dist and node_modules are git-ignored (see .gitignore).
• .txt files in this folder are not part of the site (VitePress only serves .md).
• When you add a new doc, add it to the sidebar in .vitepress/config.mjs.

Hosting

Deployed to a Cloudflare Pages project and gated by Cloudflare Access so only approved users can read it. See DEPLOY-CLOUDFLARE.md for the step-by-step dashboard guide.