Skip to content

docs: cross-link multi-family admissibility benchmark in README#138

Merged
ProfRandom92 merged 1 commit into
mainfrom
codex/cross-link-multi-family-admissibility-documentation
May 19, 2026
Merged

docs: cross-link multi-family admissibility benchmark in README#138
ProfRandom92 merged 1 commit into
mainfrom
codex/cross-link-multi-family-admissibility-documentation

Conversation

@ProfRandom92
Copy link
Copy Markdown
Owner

Motivation

  • Summary: Cross-link the deterministic multi-family admissibility benchmark documentation from a central docs entry point so the new doc is discoverable from the benchmark family section.

Description

  • Inserted a new "Multi-Family Operational Admissibility Benchmark" entry into README.md that links to docs/benchmarks/multi_family_admissibility_benchmark.md and includes the requested one-line description about manifest-driven fixture selection, exact scoring, reproducible JSON artifacts, and progression-regression checks.

Testing

  • Testing: ran npm run check (which performs layout, typecheck, validate, build, and pytest) and all checks passed; Changed files: README.md; Risks: Low (docs-only change); Next: optionally add the same cross-link to additional docs index pages in a follow-up docs-only PR.

Codex Task

Copy link
Copy Markdown
Contributor

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

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 updates the README.md file to include a new section for the 'Multi-Family Operational Admissibility Benchmark,' outlining its validation criteria and providing a link to the methodology documentation. Feedback suggests refining the validation description to align with the existing 'whether...' or 'how...' phrasing used in other sections and adding a link to the corresponding JSON artifact for consistency.

Comment thread README.md
Comment on lines +140 to +141
- **Validates:** Deterministic multi-family operational admissibility benchmark with manifest-driven fixture selection, exact scoring, reproducible JSON artifacts, and progression-regression checks.
- **Method:** [`docs/benchmarks/multi_family_admissibility_benchmark.md`](docs/benchmarks/multi_family_admissibility_benchmark.md).
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.

medium

To maintain consistency with the other benchmark entries in the 'Benchmark family' section (e.g., Paper Replay and Agent Trace Replay), please include a link to the generated JSON artifact. Additionally, consider rephrasing the validation description to follow the established 'whether...' or 'how...' pattern used in adjacent sections to improve readability and alignment with the existing documentation style.

Suggested change
- **Validates:** Deterministic multi-family operational admissibility benchmark with manifest-driven fixture selection, exact scoring, reproducible JSON artifacts, and progression-regression checks.
- **Method:** [`docs/benchmarks/multi_family_admissibility_benchmark.md`](docs/benchmarks/multi_family_admissibility_benchmark.md).
- **Validates:** whether multi-family operational state remains admissible across manifest-driven fixtures using exact scoring, reproducible JSON artifacts, and progression-regression checks.
- **Artifact:** [`artifacts/multi_family_admissibility_results.json`](artifacts/multi_family_admissibility_results.json).
- **Method:** [`docs/benchmarks/multi_family_admissibility_benchmark.md`](docs/benchmarks/multi_family_admissibility_benchmark.md).

@ProfRandom92 ProfRandom92 merged commit 600d154 into main May 19, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant