ci: add GitHub Pages previews for documentation PRs

[julpayne]

Summary

• Add .github/workflows/pr-preview.yml so same-repo PRs get a sticky comment with a live preview at https://eval-hub.github.io/pr-preview/pr-<N>/ (Astro ASTRO_BASE set accordingly; cleaned up on close)
• Switch production deploy.yml from actions/deploy-pages to publishing dist/ on the gh-pages branch via JamesIves, with clean-exclude: pr-preview so main deploys do not wipe open previews
• Document one-time Pages / workflow-permission settings in the README

Required repo settings (before this works)

1. Settings → Pages — Deploy from a branch → gh-pages / (root) (API already reports this; confirm it matches reality after merge)
2. Settings → Actions → General → Workflow permissions — Read and write permissions (currently read-only, which will block gh-pages updates)

Notes

• Fork PRs are not previewed (rossjrw/pr-preview-action limitation); CI build still runs
• First successful production deploy after merge replaces the stale MkDocs tree on gh-pages with the current Astro site

Test plan

• Confirm workflow permissions are set to read and write
• Confirm Pages source is Deploy from branch → gh-pages
• Open or update a same-repo docs PR and verify a sticky preview comment appears
• Open https://eval-hub.github.io/pr-preview/pr-<N>/ and check links/assets resolve under the preview base path
• Merge a trivial change to main (or run Deploy Documentation) and confirm production still serves Starlight and pr-preview/ is preserved
• Close a previewed PR and confirm its pr-preview/pr-<N>/ tree is removed

Made with Cursor

[coderabbitai]

Warning

Review limit reached

@julpayne, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 54 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: e9d48f28-8475-420d-bff4-a8014628cb39

📥 Commits

Reviewing files that changed from the base of the PR and between 8de40b7 and 9838124.

📒 Files selected for processing (4)

• .github/workflows/deploy.yml
• .github/workflows/pr-preview.yml
• README.md
• astro.config.mjs

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch ci/pr-docs-preview

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[github-actions]

PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-07-22 12:58 UTC

[ppadashe-psp]

approved