scripts/benchmarks/README.md

## Benchmarks script

This folder contains a convenience script for running benchmarks and performing comparisons. It can
be run via `yarn benchmarks`. See command line help for possible commands.

The benchmark script is used in conjunction with the benchmark compare GitHub actions workflow, allowing
organization members to initiate a benchmark comparison via a GitHub comment in a PR.

### Docs

See ![the benchmark documentation](../../contributing-docs/running-benchmarks.md).
build: add documentation for running benchmarks Adds documentation for running benchmarks. 2023-06-19 10:50:29 +00:00			`## Benchmarks script`

			`This folder contains a convenience script for running benchmarks and performing comparisons. It can`
			be run via `yarn benchmarks`. See command line help for possible commands.

			`The benchmark script is used in conjunction with the benchmark compare GitHub actions workflow, allowing`
			`organization members to initiate a benchmark comparison via a GitHub comment in a PR.`

			`### Docs`

docs: fix outdated links from docs to contributing-docs folder in markdown documents (#56462) PR Close #56462 2024-06-14 23:23:00 +02:00			`See ![the benchmark documentation](../../contributing-docs/running-benchmarks.md).`