docs(evaluator): fix Open Source SDK link and drop gated benchmarks pages - #1345
Conversation
|
…ages Point the Open Source SDK button on the Evaluate Agents & Models page at packages/nemo_evaluator_sdk in nemo-platform instead of NVIDIA-NeMo/evaluator. Delete the evaluator benchmarks pages: they are omitted from docs/fern/versions/latest.yml, so Fern never built or served them, and no published page links into them. Their gated-nav.yml block and the two snippets used only by those pages go with them. Signed-off-by: Sandy Chapman <schapman@nvidia.com>
4de54e5 to
25519e4
Compare
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (13)
💤 Files with no reviewable changes (12)
Included review availability: Your plan includes up to 12 reviews per rolling hour; 11 remain after this review. 📝 WalkthroughWalkthroughThe pull request removes evaluator benchmark documentation and its gated navigation entries. It also updates the evaluator page link to the SDK directory in the ChangesEvaluator documentation updates
Suggested reviewers: Merge Risk: ⚪ Minimal · up to This change corrects the Open Source SDK link and removes evaluator benchmark pages that were already unpublished; documentation checks and broken-link validation pass, so no actionable merge-blocking risk remains. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Summary
The Open Source SDK button on the Evaluate Agents & Models page pointed at
NVIDIA-NeMo/evaluator, which is the wrong SDK. It now points atpackages/nemo_evaluator_sdkin this repo. This PR also deletes the evaluator benchmarks pages, which have been gated out of the build for a while: they are omitted fromdocs/fern/versions/latest.yml, so Fern never built or served them (they 404 and are not indexed), and no published page links into them.Changes
docs/evaluator/index.mdx: Open Source SDK button now links tohttps://github.com/NVIDIA-NeMo/nemo-platform/tree/main/packages/nemo_evaluator_sdk(that directory has aREADME.md, so GitHub renders it as the landing page).docs/evaluator/benchmarks/(9 pages: overview, industry, custom, agentic, manage-benchmarks, job-management, results, and the two include-only pages).docs/fern/snippets/evaluator/benchmarks/(discover-industry-benchmarks.mdx,hf-secret.mdx) — consumed only by the deleted pages.docs/fern/gated-nav.yml. The evaluator metrics entries in that section are untouched.One inbound link to the old repo remains at
docs/evaluator/benchmarks/industry.mdx— it goes away with the deleted file.Type of Change
Quality Gates
make docs-checkandmake docs-broken-links, both run below.Verification
Signed-off-by:traileruv run pre-commit run -apasses, or any blocked checks are identified belowTargeted validation:
make docs-check— passed.validate-lfs-assets: 75 docs assets are resolved;fern check: 0 errors;validate-mdx: 209 files parsed cleanly;validate-notebook-viewer: 7 NotebookViewer notebook(s) present;check:gated-links: no inbound links from published pages into gated pages.make docs-broken-links— passed (All checks passed).uv run pre-commit run --files docs/evaluator/index.mdx docs/fern/gated-nav.yml— passed (copyright headers, merge-conflict check; the Python/Helm/UI hooks report no files to check).uv run pre-commit run -a— not clean on this branch, and not clean onmaineither. It rewrites ~30 files untouched by this PR (SPDX headers, OpenAPI specs, lockfiles) and theRun UI lint-stagedhook fails withmise ERROR No version is set for shim: pnpmin my environment. I reverted all of that and kept only the docs changes, so this pre-existing drift is not carried into the PR.Summary by CodeRabbit