Skip to content

docs(evaluator): fix Open Source SDK link and drop gated benchmarks pages - #1345

Merged
SandyChapman merged 1 commit into
mainfrom
docs-evaluator-sdk-link/schapman
Aug 18, 2026
Merged

docs(evaluator): fix Open Source SDK link and drop gated benchmarks pages#1345
SandyChapman merged 1 commit into
mainfrom
docs-evaluator-sdk-link/schapman

Conversation

@SandyChapman

@SandyChapman SandyChapman commented Aug 17, 2026

Copy link
Copy Markdown
Contributor

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 at packages/nemo_evaluator_sdk in this repo. This PR also deletes the evaluator benchmarks pages, which have been gated out of the build for a while: they are omitted from docs/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 to https://github.com/NVIDIA-NeMo/nemo-platform/tree/main/packages/nemo_evaluator_sdk (that directory has a README.md, so GitHub renders it as the landing page).
  • Deleted docs/evaluator/benchmarks/ (9 pages: overview, industry, custom, agentic, manage-benchmarks, job-management, results, and the two include-only pages).
  • Deleted docs/fern/snippets/evaluator/benchmarks/ (discover-industry-benchmarks.mdx, hf-secret.mdx) — consumed only by the deleted pages.
  • Removed the corresponding benchmarks block from 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

  • Code change (feature, bug fix, or refactor)
  • Code change with documentation updates
  • Documentation only
  • Contributor tooling or automation
  • CI, build, or test infrastructure

Quality Gates

  • Tests added or updated for changed behavior
  • Existing tests cover changed behavior — justification:
  • Tests not applicable — justification: docs-only change; the docs surface is covered by make docs-check and make docs-broken-links, both run below.
  • Documentation updated for user-visible behavior
  • Documentation not applicable — justification:

Verification

  • Pull request title follows the repository's Conventional Commit format
  • Every commit includes an appropriate Signed-off-by: trailer
  • uv run pre-commit run -a passes, or any blocked checks are identified below
  • Targeted tests pass, or tests are marked not applicable above
  • No secrets, API keys, or credentials are included

Targeted 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 -anot clean on this branch, and not clean on main either. It rewrites ~30 files untouched by this PR (SPDX headers, OpenAPI specs, lockfiles) and the Run UI lint-staged hook fails with mise ERROR No version is set for shim: pnpm in 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

  • Documentation
    • Removed outdated evaluator benchmark documentation, including setup, discovery, management, execution, results, and troubleshooting guides.
    • Removed related benchmark navigation entries and code examples.
    • Updated the Open Source SDK link to the current repository location.

@github-actions github-actions Bot added the docs label Aug 17, 2026
@github-actions

github-actions Bot commented Aug 17, 2026

Copy link
Copy Markdown
Contributor
Suite Lines Covered Line Rate Branch Rate
Unit Tests 34299/43312 79.2% 64.0%
Integration Tests 20251/41111 49.3% 22.0%

@SandyChapman
SandyChapman marked this pull request as ready for review August 17, 2026 18:19
@SandyChapman
SandyChapman requested review from a team as code owners August 17, 2026 18:19
@SandyChapman
SandyChapman enabled auto-merge August 17, 2026 18:39
…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>
@SandyChapman
SandyChapman force-pushed the docs-evaluator-sdk-link/schapman branch from 4de54e5 to 25519e4 Compare August 18, 2026 11:08
@coderabbitai

coderabbitai Bot commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 09992d97-6a6c-4d49-9b7d-4a2bf0bf05e3

📥 Commits

Reviewing files that changed from the base of the PR and between eec9179 and 25519e4.

📒 Files selected for processing (13)
  • docs/evaluator/benchmarks/agentic.mdx
  • docs/evaluator/benchmarks/custom.mdx
  • docs/evaluator/benchmarks/discover-industry-benchmarks.mdx
  • docs/evaluator/benchmarks/hf-secret.mdx
  • docs/evaluator/benchmarks/index.mdx
  • docs/evaluator/benchmarks/industry.mdx
  • docs/evaluator/benchmarks/job-management.mdx
  • docs/evaluator/benchmarks/manage-benchmarks.mdx
  • docs/evaluator/benchmarks/results.mdx
  • docs/evaluator/index.mdx
  • docs/fern/gated-nav.yml
  • docs/fern/snippets/evaluator/benchmarks/discover-industry-benchmarks.mdx
  • docs/fern/snippets/evaluator/benchmarks/hf-secret.mdx
💤 Files with no reviewable changes (12)
  • docs/fern/snippets/evaluator/benchmarks/hf-secret.mdx
  • docs/evaluator/benchmarks/hf-secret.mdx
  • docs/evaluator/benchmarks/custom.mdx
  • docs/fern/gated-nav.yml
  • docs/evaluator/benchmarks/job-management.mdx
  • docs/evaluator/benchmarks/industry.mdx
  • docs/evaluator/benchmarks/manage-benchmarks.mdx
  • docs/evaluator/benchmarks/results.mdx
  • docs/evaluator/benchmarks/index.mdx
  • docs/evaluator/benchmarks/discover-industry-benchmarks.mdx
  • docs/fern/snippets/evaluator/benchmarks/discover-industry-benchmarks.mdx
  • docs/evaluator/benchmarks/agentic.mdx

Included review availability: Your plan includes up to 12 reviews per rolling hour; 11 remain after this review.


📝 Walkthrough

Walkthrough

The pull request removes evaluator benchmark documentation and its gated navigation entries. It also updates the evaluator page link to the SDK directory in the nemo-platform repository.

Changes

Evaluator documentation updates

Layer / File(s) Summary
Retire benchmark documentation
docs/evaluator/benchmarks/*, docs/fern/gated-nav.yml
Benchmark documentation pages and their gated navigation entries were removed.
Update SDK repository link
docs/evaluator/index.mdx
The Open Source SDK button now links to the nemo_evaluator_sdk directory in the nemo-platform repository.

Suggested reviewers: a2bondar

Merge Risk: ⚪ Minimal · up to 25519

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)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes both main changes: correcting the Open Source SDK link and removing gated benchmark pages.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs-evaluator-sdk-link/schapman

Comment @coderabbitai help to get the list of available commands.

@github-actions

Copy link
Copy Markdown
Contributor

@SandyChapman
SandyChapman added this pull request to the merge queue Aug 18, 2026
Merged via the queue into main with commit 137a5e5 Aug 18, 2026
61 checks passed
@SandyChapman
SandyChapman deleted the docs-evaluator-sdk-link/schapman branch August 18, 2026 11:34
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.

3 participants