Skip to content

docs: bring the published docs in line with v0.5.0 - #186

Merged
rng1995 merged 1 commit into
mainfrom
docs/v0.5.0-refresh
Oct 7, 2026
Merged

rng1995 merged 1 commit into
mainfrom
docs/v0.5.0-refresh

Conversation

@rng1995

@rng1995 rng1995 commented Oct 7, 2026

Copy link
Copy Markdown
Collaborator

Summary

v0.5.0 published successfully to https://docs.nvidia.com/skills/skillevaluator/, and the Harbor 0.24 content was already live. This PR fills the gaps that remained: features in the 0.5.0 changelog that no page described, and statements the v0.5.0 CLI or source contradicts. Every page under docs/ was checked against --help output, the source, and the changelog.

New content

Corrections

  • CLI reference:
    • Adds validate --workers and --previous-version.
    • Lists all 24 --env-mode values, plus wandb → cwsandbox and the nine backends that can't be selected.
    • Adds the reserved --ek names and the rejection of kwargs a backend doesn't accept.
    • Fixes the --timeout-multiplier scope and default.
    • Notes that --refine doesn't need the tier3 extra to read existing results.
    • Gives the dedup-scan report basename.
  • Exit codes (CLI reference, CI, Tier 1): removes code 3. ExitCode.RUNTIME_ERROR is never used, and an unexpected error exits 1. Code 2 is now described as a Click usage error.
  • Custom graders:
    • Corrects the separate-verifier precedence: a step tests/ directory is a dedicated verifier only with a Dockerfile/docker-compose.yaml or docker_image.
    • Case IDs come from the staged task.
    • Custom graders get no trajectory rebuild.
    • Covers dual-arm [task] name suffixes.
  • Reports: adds the contents of trials/, trajectory_source / omitted in reward.json, and the logical-attempt overall when standard and custom rewards are mixed.
  • Agents & sandboxes / configuration:
    • Unknown --ek keys are rejected; drop modal_sandbox_v2.
    • stream and enable_environment_dir_upload are reserved.
    • With NVIDIA Build, OpenCode follows SKILL_EVAL_LLM_MODEL, while Codex and Claude Code keep Super.
    • Export credentials in the shell, because .env is not loaded.
  • Others:
    • Tier 1: non-string YAML keys are reported.
    • Eval datasets: refining from existing results works without tier3.
    • Installation: tier3 extra pins.
    • Benchmark rollout: Tier 3 runs by default.
    • CI: SARIF in the gate command.
    • Developer guide: CITATION.cff excerpt.
    • Page lists in docs/README.md and docs/AGENTS.md.

Verification

  • fern check: 0 errors. The only warning is the redirects check, which needs FERN_TOKEN.
  • A script confirmed every .mdx#anchor cross-link resolves to a heading. Added lines contain no bare < or {.
  • Docs-related and golden tests (test_benchmark_rollout_docs, test_oss_packaging, tests/golden, …): 687 passed, 2 skipped.
  • Exit codes checked live: a missing path and an unknown flag both exit 2.

Merging publishes to docs.nvidia.com through publish-docs.yml.

🤖 Generated with Claude Code

Audit every page under docs/ against the v0.5.0 CLI, source, and
changelog, and fill the gaps the release left:

- Tier 3: document how standard grading builds each judge's evidence
  bundle, rebuilds trajectories from opencode.txt and codex.txt logs,
  requests structured JSON (response_format / output_config) with
  schema downgrade, and retries within the per-judge time budget.
- Environment variables: add the evidence-budget variables, a retry and
  judge-budget section, the Harbor process environment (.env not read),
  LLM_JUDGE_FALLBACK_MODELS, and the output-provenance key file.
- CLI reference: add validate --workers and --previous-version, list
  all 24 --env-mode values and reserved --ek names, and document the
  exit codes the CLI returns (0, 1, 2); code 3 is never produced.
- Custom graders, reports, agents and sandboxes, configuration,
  installation, eval datasets, Tier 1, CI, benchmark rollout, and the
  developer guide: correct verifier precedence, reward artifacts, kwarg
  rejection, NVIDIA Build agent defaults, non-string YAML keys, refine
  without the tier3 extra, and the CITATION.cff excerpt.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Narendran Raghavan <nraghavan@nvidia.com>
@rng1995
rng1995 merged commit f32c884 into main Oct 7, 2026
17 checks passed
@rng1995
rng1995 deleted the docs/v0.5.0-refresh branch October 7, 2026 06:38
chrisknvidia added a commit that referenced this pull request Oct 7, 2026
Conflicts (docs only):
- CHANGELOG.md: keep the plugin evaluation entries and add main's
  documentation-refresh entry under Unreleased > Fixed.
- docs/cli-reference.mdx: keep this branch's --repo-root,
  --resolve-endpoints and claude-validate rows and the experimental
  hermes agent; take main's new --workers and --previous-version rows,
  the full --env-mode backend list, and the fuller --environment-kwarg
  row (a superset of this branch's).
- docs/tier3-live-evaluation.mdx: take main's wording for the reward and
  step-exception note and keep this branch's bullet that Harbor 0.24's
  stream and enable_environment_dir_upload options are reserved.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Christopher Kevin <christopherk@nvidia.com>
@rng1995 rng1995 mentioned this pull request Oct 20, 2026
11 tasks done
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