Getting Started
Docs Deployment

Docs Deployment

Ledger UI docs support both GitHub Pages and Vercel.

GitHub Pages

  • Workflow: .github/workflows/docs.yml
  • Build target: static export from docs-site/out
  • Trigger: push to main with docs-site changes

Vercel

  • Root directory: docs-site
  • Build command: pnpm build
  • Output directory: out

Domain Setup Checklist

  1. Add custom domain in GitHub Pages or Vercel settings.
  2. Configure DNS records (CNAME for subdomain, A/ALIAS for apex).
  3. Enable HTTPS after propagation.
  4. Ensure docs-site/public/CNAME matches the canonical domain.
  5. Validate canonical docs URL resolves to latest deployment.

Canonical domain: https://docs.gtcxprotocol.org (opens in a new tab)