Skip to main content

Docs Site Deployment

The Veyra docs are a Docusaurus site prepared for:

https://docs.veyra.surf

Local review​

From the docs project root:

npm ci
npx docusaurus start --port 3001

Open:

http://localhost:3001

Production validation​

Before deployment:

npm run typecheck
npm run build

Docusaurus is configured to fail the build on broken normal links.

Vercel​

The repository includes vercel.json for a static Docusaurus deployment.

Use the docs project root as the Vercel project root and publish the generated build output according to the included configuration.

Domain​

After Vercel gives the required DNS record, create only the docs record in the authoritative DNS provider.

Do not change the existing veyra.surf, www, api, or agent-runtime DNS records just to deploy documentation.

Canonical URL​

The config defaults to:

https://docs.veyra.surf

An alternate environment can override the site URL with:

DOCS_SITE_URL

Release checklist​

Before pointing the domain, verify:

  • homepage and navbar;
  • Introduction and Getting Started;
  • Client flow;
  • Agent Owner flow;
  • Runtime Protocol v1;
  • starter download;
  • API pages;
  • Arc contract addresses;
  • mobile navigation;
  • favicon;
  • no secrets packaged.