Skip to content

Make the celeris, loadgen, probatorium and docs READMEs attractive for visitors: consistent live badges (Codecov, CodSpeed, Scorecard; drop Go Report Card and stale tier badges) and a stronger first screen #700

Description

@FumingPower3925

Make the READMEs of all four public repos attractive and trustworthy for first-time visitors: celeris, loadgen, probatorium and docs. This is the presentation half. #414 stays the release-data half: regenerating the benchmark hero and headline numbers from the v1.6.0 bench, and correcting the stale arm64 and SIMD claims. The two should land together before the v1.6.0 announcement.

What is there today (read 2026-09-26)

repo badges now problems
celeris CI, Nightly Validation, Weekend Soak (both probatorium tiers), Go Reference, Go Report Card, License The Go Report Card badge is to be removed. The two tier badges report the last run of workflows whose schedules have been paused since probatorium#380; Weekend Soak's last runs failed, so a visitor sees a red badge that says nothing about the code today.
loadgen Go Reference, CI, License No coverage or benchmark signal.
probatorium Nightly Validation, Weekend Soak, Test, Lint, License Same stale-tier-badge problem.
docs site, License, "Astro 5", "Bun ≥1.3" (HTML badges) "Astro 5" is stale: the site runs Astro 7.3. The style differs from the other three.

All four already have a cover image (.github/cover.png).

Badges: one consistent row per repo, and only ones that are true and live

  • Remove: Go Report Card (celeris).
  • Add where it applies, now that add CodeRabbit, CodSpeed and Codecov #690 installs the services:
    • Codecov coverage, on all four: https://codecov.io/gh/goceleris/<repo>/graph/badge.svg, linking to the Codecov page. Add it only after main has a first upload.
    • CodSpeed, on celeris and loadgen (the repos with benchmarks): https://img.shields.io/endpoint?url=https://codspeed.io/badge.json, linking to the repo's CodSpeed page. Add it once main has a macro-runner baseline.
    • OpenSSF Scorecard, on celeris (it already runs the Scorecard workflow): https://api.scorecard.dev/projects/github.com/goceleris/celeris/badge.
    • Latest release and Go version from go.mod (shields.io) for the Go repos.
    • CI for each repo's own required workflow.
  • Validation-tier badges: keep them only if they reflect a run that is actually scheduled or recent. Otherwise replace them with a link to the latest validation report, or bring them back when the tiers run on a cadence again.
  • Use one style across the four repos: a centered row under the cover, with badges grouped as status → quality → project.

Content: what a visitor needs in the first screen

  • celeris:
  • loadgen: what it is for, one install-and-run example, the headline properties (allocation, HTTP/1.1 and HTTP/2, latency correctness), and how celeris uses it.
  • probatorium: what it proves and how (tiers, invariants, arm64 + x86 cluster), where the latest results live, and how to reproduce a run.
  • docs: what the site is, how to run it locally (bun install && bun run dev), and the current stack versions, read from package.json rather than hard-coded.
  • All four:
    • Consistent headings and working relative links.
    • Alt text on every image.
    • A short "Related projects" footer linking the other three.

Acceptance criteria

  • celeris README updated; Go Report Card gone; badge row consistent and all green or neutral on the day it merges
  • loadgen README updated
  • probatorium README updated
  • docs README updated (stale "Astro 5" fixed)
  • Every badge renders, links somewhere useful, and reflects something that runs today; no stale status
  • Every factual claim is checked against code or published data, with the check noted in the PR
  • Rendered on GitHub in light and dark mode, and on a phone-width viewport, before merging

Depends on: #690 (the Codecov and CodSpeed badges need first uploads on main), and pairs with #414.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions