Skip to content

docs: publish compiler and rules benchmarks - #39

Merged
kvlonge merged 2 commits into
mainfrom
docs/add-benchmarks-page
Sep 10, 2026
Merged

kvlonge merged 2 commits into
mainfrom
docs/add-benchmarks-page

Conversation

@kvlonge

@kvlonge kvlonge commented Sep 10, 2026

Copy link
Copy Markdown
Contributor

Why

SQLBuild's required CI now provides useful compiler and Rules performance evidence, but the public documentation did not explain the production-shaped workload or publish the measured results. The Custom Rules navigation also used a clickable group root instead of the clearer Overview-child pattern used elsewhere.

Changes

  • add a top-level Benchmarks page under Getting Started
  • document the real-project calibration, resource ratios, SQL-size distribution, compiler timings, 5,000-model Rules timings, exact invalidation evidence, environment, and reproduction commands
  • add a concise performance result and benchmark link to the Rules overview
  • shorten the built-in/custom explanation into scannable bullets
  • move Custom Rules authoring content to an explicit Overview child
  • preserve old Rules and Custom Rules URLs with permanent redirects

Verification

  • validated all documented benchmark commands against their current CLI help
  • checked benchmark counts, SQL bytes, timings, and cache counters against generated projects and required-CI artifacts
  • validated docs.json and Markdown fences
  • git diff --check
  • public-repository hygiene scan

@kvlonge
kvlonge enabled auto-merge (squash) September 10, 2026 08:16
@kvlonge
kvlonge merged commit 051439b into main Sep 10, 2026
3 checks passed
@kvlonge
kvlonge deleted the docs/add-benchmarks-page branch September 10, 2026 08:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant