Docs

Deployment

Build, hosting, and environment configuration.

From commit to preview
Deployments are designed for Vercel with telemetry surfaces that stay cached and rate-limit safe. Previews stay visible in the work-in-progress page to keep the site alive.
Vercel Previews Telemetry Caching

Build steps

  • 01. Build
    npm run build compiles Next.js and static assets.
  • 02. Preview
    Vercel generates preview deployments per branch or PR.
  • 03. Telemetry
    APIs surface build status and repo activity with caching.
  • 04. Ship
    Production deploys update the live site and RSS feeds.
GitHub commit
Vercel build
Preview URLs
Production deploy

Hosting

  • The site is designed for Vercel hosting and static delivery.
  • The build output includes static assets in public/ and pre-rendered routes.

Environment configuration

  • NEXT_PUBLIC_SITE_URL controls canonical URLs in the sitemap.
  • VERCEL_TOKEN + VERCEL_PROJECT_ID are required for build telemetry.
  • VERCEL_TEAM_ID is optional for team-scoped projects.
  • GITHUB_TOKEN boosts GitHub API limits for pipeline + project telemetry.
Variable Purpose Used by
NEXT_PUBLIC_SITE_URL Canonical base URL Sitemap + RSS generation
VERCEL_TOKEN Vercel API access Build + preview telemetry
VERCEL_PROJECT_ID Project lookup Preview deployments
VERCEL_TEAM_ID Team scoping Optional for team projects
GITHUB_TOKEN GitHub API access Pipelines + project details

Telemetry surfaces

  • /api/site-build-status surfaces Vercel deployment states.
  • /api/pipeline-status and /api/project-details read GitHub workflow and repo signals.
  • /api/github-metrics exposes historical activity snapshots.
  • See Telemetry and APIs for cache rules, refresh controls, and metrics storage.

Automation ties

  • GitHub Actions handles releases, metrics refreshes, and syndication.
  • Vercel cron provides a redundant metrics refresh trigger.
  • See Automation and CI/CD for workflow details.
Local checklist
  • Copy .env.local values into the local environment.
  • Run npm run dev and verify telemetry cards load.
  • Open /work-in-progress to confirm preview data.