Commands:
- Dev:
pnpm run dev- Start local development server - Build:
pnpm run build- Generate static content with Zudoku - Test: No automated tests found
- Typecheck:
pnpm run typecheck- Run TypeScript checks (uses tsgo) - Lint (links):
pnpm run check- Check assets and external links - Lint (text):
make lint- Run Vale for style and errors - Format:
pnpm run format- Run Prettier
Architecture:
- Zudoku-based documentation site with React 19 and TypeScript
- Main docs in
/docs/, generated content in/generated/ - Policies auto-generated in
/policies/, errors in/docs/errors/ - Components in
/src/, configuration inzudoku.config.tsx - PostHog analytics, Inkeep search, API docs from
api.json
Style Guidelines:
- Use ES modules (type: "module"), React 19, strict TypeScript
- Target audience: software developers building APIs
- American English, present tense, avoid passive voice/first-person
- Follow Microsoft Writing Style Guide, format with Prettier
- Admonitions: Use
:::note,:::tip,:::warning,:::caution,:::danger - Ensure line breaks before/after
:::blocks for proper formatting - Friendly, professional, informative tone with clear structure