Skip to main content

QAVE Studio Documentation

Welcome to the QAVE Studio docs site. This site is served at https://docs.qavestudio.ai as a static build generated from this same repo (docs/ folder) via Jenkins CI and Caddy.

Where things live today​

The in-depth product and engineering docs currently live as Markdown in this repo and are being migrated here page by page:

  • docs/MASTER_WRITEUP.md — product master writeup
  • docs/DEPLOYMENT_OPTIONS.md — deployment options
  • docs/DEVOPS_DEPLOYMENT_PLAYBOOK.md — DevOps playbook
  • docs/specs/ — feature specs (00–10 series)
  • docs/superpowers/ — plans and specs
  • App user docs — also available in-product at /documentation (Fumadocs)

How this site is published​

  1. Authors edit Markdown under docs/docs/ (this folder).
  2. Jenkins Build Docs stage runs npm ci && npm run build inside docs/.
  3. The docs/build/ output is rsynced to the droplet at /opt/qave-application/qave/docs/build.
  4. Caddy serves it on docs.qavestudio.ai with file_server + try_files.

Start with the Intro page and the tutorials in the sidebar while migration is in progress.