Skip to content

docs: update references after rename to website-results #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
matbrgz merged 1 commit into from
Oct 12, 2026
Merged

docs: update references after rename to website-results #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# AGENTS.md — website
# AGENTS.md — website-results

Follow the org-wide rules in [BenchCommons/.github AGENTS.md](https://github.com/BenchCommons/.github/blob/main/AGENTS.md) and the decisions in [.product](https://github.com/BenchCommons/.product). This file only adds what is specific to this repo.

Expand Down
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# BenchCommons website
# BenchCommons website-results

The results website of the BenchCommons static site generator benchmarks: every round, suite and generator from
[benchmark-tool](https://github.com/BenchCommons/benchmark-tool), with the generator metadata of
[ssg-frameworks](https://github.com/BenchCommons/ssg-frameworks). Spec, plan and tasks:
[tools-benchmark](https://github.com/BenchCommons/tools-benchmark), with the generator metadata of
[catalog-ssg](https://github.com/BenchCommons/catalog-ssg). Spec, plan and tasks:
[docs/specs/001-results-website](docs/specs/001-results-website/spec.md).

It is a static Svelte app. At build time `scripts/build-data.mjs` reads the two repositories, pinned as git submodules
Expand All @@ -11,8 +11,8 @@ in `data/`, and writes `public/data/rounds.json` plus one JSON file per round. T
## Develop

```sh
git clone --recurse-submodules https://github.com/BenchCommons/website
cd website
git clone --recurse-submodules https://github.com/BenchCommons/website-results
cd website-results
npm ci
npm run dev # build the data, then start Vite
npm test # unit tests (Vitest)
Expand All @@ -26,7 +26,7 @@ Every view is a link: the section, round, suite, cell, view and filters live in

## Publish a new round

A round appears once its result files are on benchmark-tool `main` under `docs/results/<YYYY-MM-DD>/`. Move the
A round appears once its result files are on tools-benchmark `main` under `docs/results/<YYYY-MM-DD>/`. Move the
submodule to that commit and open a pull request:

```sh
Expand Down
2 changes: 1 addition & 1 deletion docs/specs/001-results-website/spec.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

- **Date:** 2026-10-11
- **Status:** draft
- **Repo:** `BenchCommons/website`. Reads, but does not change, `BenchCommons/benchmark-tool` (BT) and `BenchCommons/ssg-frameworks` (SF).
- **Repo:** `BenchCommons/website-results`. Reads, but does not change, `BenchCommons/tools-benchmark` (BT) and `BenchCommons/catalog-ssg` (SF).
- **Related:** BT `008-benchmark-methodology` (suites, `results.json`, `suite-summary.csv`, fingerprints), BT `009-output-quality` (`quality` section, `quality-summary.csv`), SF `generators.json` (generator metadata).

## Context
Expand Down
Loading