GitHub Pages Deployment

Cur8d uses GitHub Pages to host the static Nextra documentation website.

Automated Documentation Deployment

The .github/workflows/docs.yml workflow automatically builds and publishes the documentation site to GitHub Pages whenever changes are pushed to docs/** on the main branch or when triggered via workflow_dispatch.

How It Works

1. Static Export: Runs mise run docs:build (which executes pnpm --filter docs build), generating a static HTML bundle in docs/out.
2. Pages Configuration: Configures GitHub Pages settings with actions/configure-pages@v6.
3. Artifact Upload: Packages docs/out using actions/upload-pages-artifact@v5.
4. Deployment: Deploys the static bundle to your repository’s GitHub Pages domain with actions/deploy-pages@v5.

Local Build & Verification

To build and preview the static documentation locally:

# Build the static export
mise run docs:build
 
# Serve the exported documentation
mise run docs