Repository navigation
docs: point stale resources-server config paths at files on main - #4639
Merged
Merged
Conversation
Three latest pages cite resources_servers/*/configs/*.yaml files that do not exist on main: - reference/cli-commands.mdx (and the `gym env prefetch` docstring it was copied from, #2161 -> #4093): resources_servers/math/configs/math.yaml never existed; use math_with_judge/configs/math_with_judge.yaml. - contribute/.../gym-rl-framework-integration-success-criteria.mdx: the DAPO17k link pinned bytedtsinghua_dapo17k.yaml, which #859 folded into dapo17k.yaml; link that file on main. - reference/faq.mdx: multineedle was renamed to example_multi_step in #291. Add a docs test that every config path cited under latest exists, skipping my_weather_tool, which the single-step tutorial has the reader create. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Signed-off-by: qiaochuz <qiaochuz@nvidia.com>
Contributor
Author
|
/ok to test 1023e7f |
Contributor
|
🌿 Preview your docs: https://nvidia-preview-pr-4639-1023e7f557fd.docs.buildwithfern.com/nemo/gym |
ananthsub
approved these changes
Oct 15, 2026
Contributor
|
🔄 Merge queue validation started! You can track the progress here: https://github.com/NVIDIA-NeMo/Gym/actions/runs/38786930668 |
Contributor
Author
|
Retrospective QA-fix tracking issue: #4699 |
This branch was previously deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Three pages under
fern/versions/latest/pagesciteresources_servers/*/configs/*.yamlfiles that do not exist on main. This PR points each one at the file that replaced it. It also adds a docs test so the next rename that leaves a citation behind fails CI.No issue or NVBug: found by scanning the latest pages for cited config paths and checking each one exists:
reference/cli-commands.mdx(gym env prefetchexample)resources_servers/math/configs/math.yamlresources_servers/math_with_judge/configs/math_with_judge.yamlresources_servers/math/never existed. The example came from theprefetchdocstring added in #2161 and was copied into the page by #4093.math_with_judge.yamlis the math config the same page already uses forng_e2e_collect_rollouts. The docstring innemo_gym/cli/env.pygets the same fix.contribute/rl-framework-integration/gym-rl-framework-integration-success-criteria.mdxmath_with_judge/configs/bytedtsinghua_dapo17k.yaml(pinned to299e8c04)math_with_judge/configs/dapo17k.yamlonmainbytedtsinghua_dapo17k.yamland moved its DAPO17k train and AIME24 validation sets intodapo17k.yaml. The pinned permalink still resolves, but it points at a config that main no longer ships. The other links in this page's tables already usemain.reference/faq.mdx(4 dataset upload/migrate examples)resources_servers/multineedle/configs/multineedle.yamlresources_servers/example_multi_step/configs/example_multi_step.yamlmultineedletoexample_multi_step. The upload command readsdomainfrom this config, andexample_multi_step.yamlsets it.Versioned snapshots under
fern/versions/v*/are frozen and left as they shipped.Test
tests/unit_tests/test_fern_docs_links.py::test_cited_resources_server_configs_existscans every latest page forresources_servers/<name>/configs/<file>.yamland asserts that each file exists. It skipsmy_weather_tool, whichenvironment-tutorials/single-step-environment.mdxhas the reader create. It also asserts that it found at least one citation, so a broken regex can't make it pass vacuously.Before the fix
Gym
974d1a921(main). The new test fails (1 failed) and reports these six citations:The documented
gym env prefetchexample, run with venv installs stubbed out so that only config resolution and server discovery run (policy_model_nameis normally supplied byenv.yaml):After the fix
gym env resolve --confignow findsdapo17k.yamlandexample_multi_step.yaml. It then stops at the usual unset-required-values check (policy_model/ judge name), the same as any config resolved without anenv.yaml.Validation
pytest tests/unit_tests/test_fern_docs_links.py tests/unit_tests/test_opensandbox_documented_config.py: 25 passed, 21 subtests passed.pytest tests/unit_tests/test_cli_main.py: passed (theenv.pychange only touches a docstring).pre-commit run --all-files: all hooks pass.🤖 Generated with Claude Code