Reference

Docs Hosting

Host the documentation as a standalone experience on docs.axiomdb.squareexp.com.

The docs live in the same Next app and render under /docs locally.

Production should also expose them as a standalone docs domain:

https://docs.axiomdb.squareexp.com

Local preview

npm run dev -- --port 3000
open http://localhost:3000/docs

Domain behavior

Requests from the docs domain are rewritten into the docs route:

docs.axiomdb.squareexp.com/cli -> /docs/cli
docs.axiomdb.squareexp.com/reference/cli -> /docs/reference/cli

The public product console remains on the ops domain.

Required DNS

Create an A record:

docs.axiomdb.squareexp.com -> <VPS public IP>

Required env

AXIOMDB_DOCS_DOMAIN=docs.axiomdb.squareexp.com
NEXT_PUBLIC_AXIOMDB_DOCS_URL=https://docs.axiomdb.squareexp.com

TLS

Issue a certificate for the docs domain on the VPS. Nginx can then serve the docs host on HTTPS and proxy to the same Next process.

On this page