Skip to main content

GitHub Pages Deployment

This site is deployed to GitHub Pages at https://docs.bugsport.io using GitHub Actions.

Automated Deployment​

A CI workflow (.github/workflows/deploy.yml) automatically builds and deploys the site on every push to the main branch.

Workflow Summary​

  1. Checks out the repository.
  2. Installs Node.js 20 and project dependencies via npm ci.
  3. Runs npm run build to generate static output.
  4. Uploads the build/ directory as a GitHub Pages artifact.
  5. Deploys the artifact to GitHub Pages.

One-Time Repository Setup​

  1. Go to Settings → Pages in the repository.
  2. Set source to GitHub Actions.
  3. Add docs.bugsport.io as the custom domain and save.
  4. Wait for GitHub to validate DNS and enable HTTPS.

Troubleshooting​

  • If pages render without styles, confirm url and baseUrl values in docusaurus.config.ts.
  • If DNS validation fails, verify the CNAME record for docs.bugsport.io points to hash-line.github.io.