Commander Docs

Documentation site for Commander — multi-agent orchestration engine.

Live: https://pstarh.github.io/commander-docs/

Stack

• VitePress 1.6
• Custom home page (Vue + GSAP)
• Deployed to GitHub Pages (base: /commander-docs/)

Develop

npm install
npm run dev      # http://localhost:5173/commander-docs/
npm run check    # content guards (metrics, CLI paths, zh pages)

Build & preview

npm run ci       # check + build
npm run preview

Locales

Path	Language	Coverage
/	English	Full (source of truth)
/zh/	简体中文	Full tree — 信达雅 native
/ja/	日本語	Full tree — 信达雅 native
/ko/	한국어	Full tree — 信达雅 native
/es/	Español	Full tree — 信达雅 native
/fr/	Français	Full tree — 信达雅 native

Policy: every locale page must be full native prose (no English body + banner stubs). Code fences stay English.

Regenerate mirrors after EN content changes:

npm run locales:gen

Language switcher is in the VitePress nav.

Deploy

Push to master triggers .github/workflows/deploy.yml → GitHub Pages.

git checkout master
git add -A && git commit -m "docs: ..."
git push origin master

Structure

guide/           Getting started, usage, advanced, SDK
architecture/    Runtime, reliability, security, systems
api/             Orchestration component reference
deployment.md    Docker / VM / production
community.md     Contributing & roadmap
.vitepress/      Config + theme

Content rules

• Metrics: 25 providers · 5 topologies · 18 built-in tools · 6700+ tests (match product README / @commander/core)
• CLI from source: npx tsx packages/core/src/cliEntry.ts …
• CLI after build: commander …
• Internal links in Vue: always use withBase() — raw /guide/... breaks on GH Pages
• themeConfig.logo: /logo.svg (VitePress prefixes base automatically — do not hardcode /commander-docs/)
• OG image: public/og.png (1200×630) + head meta in config.mts
• P0 pages: why-commander, cookbook, web-console, security, migration-v2

Related

• Product: https://github.com/PStarH/Commander
• Docs repo: https://github.com/PStarH/commander-docs