Documentation for the Kamiwaza AI platform, built with Docusaurus.

• Node.js 18.0 or higher
• npm

# From repo root
npm install

# Install docs dependencies
cd docs
npm install

# From repo root (recommended)
npm run start

# Opens http://localhost:3000
# Changes reflect live without restart

1. Create feature branch

   git checkout -b feature/your-changes

2. Edit documentation

   • Edit files in docs/docs/ (platform docs) or docs/sdk/ (SDK docs)
     • Do not edit versioned_docs directly
   • Test locally: npm run start (from repo root)

3. Version the documentation (choose one):

   Option A - Create new version (for releases):

   # From repo root
   npm run version-up -- 0.6.0

   Option B - Update existing version (for fixes):

   # From docs/ directory
   export DOCS_VERSION=0.5.1
   rm -rf versioned_docs/version-$DOCS_VERSION versioned_sidebars/version-$DOCS_VERSION-sidebars.json
   node -e "const fs=require('fs');const p='versions.json';const v=JSON.parse(fs.readFileSync(p));fs.writeFileSync(p, JSON.stringify(v.filter(x=>x!=='$DOCS_VERSION'), null, 2)+'\n');"
   npm run clear
   npm run docusaurus -- docs:version $DOCS_VERSION
   npm run build

4. Verify build after versioning

   # From repo root
   npm run build
   
   # Check for broken links or build errors
   # Optional: Preview locally
   npm run serve

5. Submit pull request to main

   • Ensure build passes
   • Include description of changes

6. After merge → automatic deployment

   • GitHub Actions automatically deploys to https://docs.kamiwaza.ai
   • No manual deployment needed

• Only edit files in docs/docs/ - Don't edit versioned_docs/ directly
• Version before PR - Create or update version snapshots before submitting
• Run from repo root - Most commands should run from kamiwaza-docs/ not docs/
• Search works in production only - Use npm run build && npm run serve to test locally

docs/
├── docs/           # Current platform documentation (edit here)
├── sdk/            # SDK documentation (auto-synced)
├── blog/           # Blog posts
├── static/         # Images and static assets
├── src/            # Custom components and CSS
├── versioned_docs/ # Version snapshots (don't edit directly)
└── versioned_sidebars/ # Version sidebars (auto-generated)

npm run start         # Start dev server (from repo root)
npm run build         # Build with SDK sync (from repo root)
npm run serve         # Preview production build
npm run typecheck     # TypeScript validation
npm run clear         # Clear Docusaurus cache (from docs/)

# From repo root only
npm run version-up -- <version>   # Create new version (e.g., 0.6.0)

Deployment is automatic via GitHub Actions when merging to main.

# Linux/macOS
GIT_USER=<username> npm run deploy

# Windows
set GIT_USER=<username> && npm run deploy

1. Create .md or .mdx file in docs/docs/
2. Add to docs/sidebars.ts
3. Test locally, then version

import kamiwaza as kz
client = kz.Client()

graph TD
    A[User] --> B[API]
    B --> C[Service]

• Place in docs/static/img/
• Reference: ![alt text](/img/filename.png)

Questions? See Docusaurus docs or open an issue.