eval-hub.github.io

Documentation site for EvalHub.

Overview

This repository contains the source for the EvalHub documentation built with Astro/Starlight.

Deployment

Automatic Deployment

Documentation is built on pushes to main and published to the gh-pages branch (GitHub Pages source: Deploy from a branch → gh-pages / root).

Pull request previews

Same-repo pull requests get a sticky preview comment with a URL like:

https://eval-hub.github.io/pr-preview/pr-<number>/

Previews are cleaned up when the PR is closed. Fork PRs are not previewed (build CI still runs).

One-time repository settings (required for preview and production branch deploys):

1. Settings → Pages — Source: Deploy from a branch, Branch: gh-pages / / (root)
2. Settings → Actions → General → Workflow permissions — Read and write permissions (and allow workflows to create PRs if prompted)

Without write permissions, deploy.yml and pr-preview.yml cannot update gh-pages.

Adding Blog Posts

Blog posts live in src/content/docs/blog/. Create a new Markdown file there with this frontmatter:

---
title: "Your Post Title"
date: 2026-05-02T00:00:00.000Z
authors:
  - evalhub
excerpt: >
  A short summary shown in the blog index.
---

Post content goes here.

• date controls the publish date and sort order.
• authors must match a key defined in the starlightBlog authors config in astro.config.mjs.
• The filename becomes the URL slug (e.g. my-post.md → /blog/my-post/).

License

See the LICENSE file for details.