Skip to content

[NVBug 6570461] Fix remaining fern/versions/latest minor docs issues #4507

Open

Description

@qiaochuz-nv

Queue rank 19/48 · Difficulty 2/5 · Status on main: partially_fixed

NVBug: https://nvbugspro.nvidia.com/bug/6570461 · priority: P1-Should have · ARB: Lawrence Lane
GitHub: none found (no dedicated PR/issue; some sub-items fixed incidentally by #2294, #2359, #4175)

Summary

Umbrella docs report bundling ~20 copy/nav/redirect nits in fern/versions/latest. All are documentation-only, no behavior risk. On current main (75bb53e) it is partially_fixed: several items resolved, but the high-priority SEO description and most medium items remain.

Reproduction

git clone https://github.com/NVIDIA-NeMo/Gym.git, then review fern/versions/latest/pages/ and fern/docs.yml against the bug's item list.

Root cause

Independent authoring oversights (stale draft text, wrong link labels/targets, missing redirect rules, uncatalogued page). Each sub-item is self-contained.

Status on main (partially_fixed)

Still broken (verified):

  • reference/rl-framework-compatibility.mdx:3 description lists "TRL" but body covers NeMo RL, Unsloth, VeRL (TRL absent, VeRL omitted). HIGH.
  • model-recipes/nemotron-3-super.mdx:8 still "...posted in this document soon!". HIGH/partial.
  • verification-patterns/index.mdx:23 Reward Model card has no href (now a "coming soon" badge).
  • agent-server/index.mdx:6 comma splice "does not run an LLM itself, it is".
  • reference/faq.mdx:399-400 draft metadata "Reading time: 5 mins / Date: Fri Aug 15, 2025".
  • environment-tutorials/single-step-environment.mdx:84 "it's not atypical..."; :473 link text "[model-server-vllm]".
  • "Environment Components" label in 6 pages (should be Architecture): includes execution-and-state-match.mdx:288, system-design.mdx:7, multi-reward-verification.mdx:11, llm-as-judge.mdx:36.
  • "[Configure Model]" in quickstart.mdx:26, troubleshooting/configuration.mdx:324, adding-a-benchmark.mdx:126 vs nav "Configure Models" (fern/versions/main.yml:25).
  • BLADE page evaluation-tutorials/blade-analysis-skill.mdx exists but is not a card in evaluation-tutorials/index.mdx.

Already fixed: Equivalence Match + Execution/State Match cards now have hrefs (#2294/#2359); /evaluation-tutorials redirects added (docs.yml:151-154); rl-framework Notes use "see the" prefix; "best practices includes" gone (#4175); GPT-5/Thinking naming removed.

Proposed fix

One docs PR editing ~12 mdx files + docs.yml: correct rl-framework description to "NeMo RL, Unsloth, VeRL"; finish or clearly gate the Super recipe; fix grammar/link-label/nav-label strings above; add a BLADE card to the evaluation-tutorials index; add non-main /nemo/gym/evaluation-tutorials redirect. Use the nemo-gym-docs skill. Low-priority style items optional in the same PR.

Validation

Validated by fern docs build/link check only (cd fern && npm); no GPU. There is NO QA testcase that reviews fern/versions/latest docs, so verification is the build/link check plus a re-walk of the NVBug item list.

Triage

Difficulty 2/5 — umbrella but every remaining sub-item is a trivial, pinpointed one-file markdown/yaml edit with no behavior risk. Needs GPU: no.

Reviewer notes

Verifier confirmed all 12 paths and status partially_fixed on main (HEAD 75bb53e); difficulty held at 2. Corrections applied: rl-framework description is line 3 (not :4); the "[Environment Components]" mislabel spans 6 pages (not ~5), adding execution-and-state-match.mdx:288, system-design.mdx:7, multi-reward-verification.mdx:11, llm-as-judge.mdx:36; nav title lives in fern/versions/main.yml:25; and Validation is corrected since no QA testcase reviews fern docs.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions