From f81828e2f0bbaa7145860f7f5b8f8f37e8bca4ab Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Matheus=20Bregu=C3=AAz?= Date: Mon, 12 Oct 2026 15:25:45 -0300 Subject: [PATCH] docs: update references after rename to website-results Update README, AGENTS.md and spec 001 to the new repo names (tools-benchmark, catalog-ssg). Co-Authored-By: Claude Sonnet 5.5 --- AGENTS.md | 2 +- README.md | 12 ++++++------ docs/specs/001-results-website/spec.md | 2 +- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index ecbe60f..5716321 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -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. diff --git a/README.md b/README.md index 9c2d092..2089b47 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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) @@ -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//`. Move the +A round appears once its result files are on tools-benchmark `main` under `docs/results//`. Move the submodule to that commit and open a pull request: ```sh diff --git a/docs/specs/001-results-website/spec.md b/docs/specs/001-results-website/spec.md index 15b1817..732cecd 100644 --- a/docs/specs/001-results-website/spec.md +++ b/docs/specs/001-results-website/spec.md @@ -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