Hosting the playbook

This page covers the playbook site. The design process ends with the handoff described in the workflow.

Run it locallyCopy Anchor Link

npm ci
npm run dev

The development server listens on 127.0.0.1 and serves the playbook at /docs.

DeployCopy Anchor Link

The site is a Next.js application. On any Node.js host, build and start it:

PLAYBOOK_BASE_URL=https://jado.example.com npm run build
npm run start

On Vercel, import the repository and keep the default Next.js settings.

Base URLCopy Anchor Link

PLAYBOOK_BASE_URL is the absolute origin of the deployed site, for example https://jado.example.com. Set it at build time. The site uses it for canonical URLs, Open Graph images, robots.txt and the sitemap.

On Vercel, the project's production domain is used when PLAYBOOK_BASE_URL is unset. On other hosts, an unset value falls back to http://localhost:3000, so set it for every public deployment.

What is publicCopy Anchor Link

Every page, the search API, Markdown output and llms.txt are served without authentication. Keep secrets, credentials and client data out of the content, as described in how to contribute.