Skip to main content

Docs Site Publishing

This runbook keeps https://docs.chroma.so up to date.

How publishing works​

  1. build docs from docs-site/docs/*
  2. sync reference pages from api/docs/*
  3. deploy static build to server
  4. reload web server

Workflow file: .github/workflows/docs-deploy.yml

Required GitHub secrets​

  • DOCS_DEPLOY_HOST
  • DOCS_DEPLOY_USER
  • DOCS_DEPLOY_SSH_KEY
  • DOCS_DEPLOY_PATH

DNS and web server checks​

  • DNS A record: docs.chroma.so -> production server IP
  • nginx root points to deployed docs folder
  • unknown paths fallback to /index.html

Post-deploy checklist​

  1. open https://docs.chroma.so
  2. open one architecture page and one integration page
  3. confirm references page shows latest summary/progress/env matrix