Skip to content

Add NJS-GROWTH-07 benchmark result data contract#13

Merged
SebaSOFT merged 3 commits into
mainfrom
growth/njs-growth-07-build-proof-assets-benchmarks-playground
Jun 23, 2026
Merged

Add NJS-GROWTH-07 benchmark result data contract#13
SebaSOFT merged 3 commits into
mainfrom
growth/njs-growth-07-build-proof-assets-benchmarks-playground

Conversation

@SebaSOFT

Copy link
Copy Markdown
Owner

Summary

Adds the NJS-GROWTH-07 benchmark/result-data contract for downstream proof assets without publishing or implying measured benchmark claims.

Deliverables

  • docs/benchmarks/results.schema.json: machine-readable benchmark result schema with stable field names, units, and source explanations.
  • benchmarks/sample-results.placeholder.json: deterministic placeholder fixture marked result_kind: placeholder_sample, is_placeholder: true, and claims_allowed: false.
  • docs/benchmarks/methodology.md: competitor set, scenario matrix, input-size matrix, metric definitions, and placeholder-data policy.
  • tests/contracts/benchmark-contract.test.ts: regression coverage for the schema, sample placeholder guardrails, competitor/scenario/input matrix, and VitePress discovery link.
  • Adds docs navigation for proof assets and includes visual-proof/prompt-kit scaffolding for downstream visual agents.

Validation

  • yarn lint
  • yarn test ✅ 11 files / 59 tests
  • yarn build
  • yarn docs:build
  • yarn examples

Guardrails

  • No npm release.
  • No fabricated benchmark results.
  • Placeholder data is explicitly non-claim data and must not be used for public performance claims.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request establishes the benchmark methodology, result schema, placeholder data, and visual proof guidelines for Neuron-JS, along with a contract test suite and necessary competitor dependencies. The review feedback correctly identifies that the results schema should require the result_kind field and suggests moving the schema file to the VitePress public directory so it can be served correctly, which cascades into updating reference paths across the documentation, READMEs, and tests.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread docs/public/benchmarks/results.schema.json
Comment thread tests/contracts/benchmark-contract.test.ts Outdated
Comment thread tests/contracts/benchmark-contract.test.ts Outdated
Comment thread tests/contracts/benchmark-contract.test.ts
Comment thread docs/benchmarks/index.md Outdated
Comment thread docs/benchmarks/methodology.md Outdated
Comment thread docs/benchmarks/methodology.md Outdated
Comment thread benchmarks/README.md Outdated
SebaSOFT and others added 2 commits June 22, 2026 21:35
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Applies the remaining code-review changes that the test suite already
expected but the source did not satisfy:

- Move results.schema.json into docs/public/benchmarks/ so VitePress
  serves it at /neuron-js/benchmarks/results.schema.json (matching its
  $id); previously it lived in a content dir and was never served and
  the contract test could not find it.
- Add result_kind to the per-row required array in the schema.
- Update path references in methodology.md and benchmarks/README.md, and
  fix the index.md link to the served public URL.

Fixes the failing CI quality job (3 benchmark-contract tests).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@SebaSOFT SebaSOFT merged commit 5132e51 into main Jun 23, 2026
2 checks passed
@SebaSOFT SebaSOFT deleted the growth/njs-growth-07-build-proof-assets-benchmarks-playground branch June 23, 2026 00:54
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.

2 participants