Skip to content

Deploying Docs to Cloudflare Pages

The repository includes a GitHub Actions workflow at .github/workflows/deploy-docs.yml. It builds the Starlight site from docs/ with Bun and deploys docs/dist to Cloudflare Pages project typicalwaypoint-docs.

The configured public site URL is:

https://typicalwaypoint.simpmc.vn

Add typicalwaypoint.simpmc.vn as a custom domain on the Cloudflare Pages project so Pages serves the generated site at the same canonical URL Astro uses for sitemap and metadata output.

GitHub secrets

Set these repository secrets:

SecretPurpose
CLOUDFLARE_API_TOKENAPI token with Cloudflare Pages deploy access.
CLOUDFLARE_ACCOUNT_IDCloudflare account id that owns the Pages project.

Workflow behavior

The workflow runs on pushes to main that change:

  • docs/**
  • .github/workflows/deploy-docs.yml

It can also be run manually with workflow_dispatch.

Build steps:

Terminal window
cd docs
bun install
bun run build

Deploy command:

Terminal window
pages deploy docs/dist --project-name=typicalwaypoint-docs --branch=${{ github.ref_name }}

Local verification

Before pushing docs changes, run:

Terminal window
cd docs
bun install
bun run build

Generated .astro/, dist/, node_modules/, and package-lock.json are ignored inside docs/.