Repository navigation
cp: docs(cli): fix cli-commands.mdx issues from NVBug 6854088 (4093) into r0.7.0 - #4219
Merged
Merged
Conversation
## Summary - **Missing commands**: added `gym env schema`, `gym env prefetch`, and `gym eval submit` to both the Quick Reference table and dedicated detail sections. - **Missing options**: added `--environment` (env start, eval run), `--model-type` (dataset collate), `--search-dir` (env publish), `--json` (eval health-check), and `--environment`/`--model-type`/`--concurrency`/`--limit` (eval reverify). - **`--no-serve` example**: replaced the incorrect single-command form (which passed `--model-url`/`--model-api-key` to `eval run --no-serve`) with a correct two-terminal sequence — model settings go to `env start`, collection runs against already-running servers. - **`0.0.0.0`**: replaced with `127.0.0.1` in all client URL examples. - **`--allow-unsupported-pairing`**: corrected description in all four occurrences to include "or model type" (env validate, env start, eval run, env prefetch). - **Environment Servers**: updated `env start` description to list environment servers alongside agent/model/resources servers, and note that rollout collection dispatches `/run` through them. - **ATIF typo**: fixed "does not parse ATOF" → "does not parse ATIF" in `gym eval export`. - **Credential guidance**: added a `<Note>` in the Datasets section covering `HF_TOKEN`/`huggingface-cli login` for HuggingFace and `mlflow_tracking_token`/`MLFLOW_TRACKING_TOKEN` for GitLab; added a `<Warning>` near `--model-api-key` recommending `policy_api_key` in `env.yaml` to avoid shell-history exposure. ## Validation Docs-only change. Each addition was verified against the CLI source (`nemo_gym/cli/main.py`, `env.py`, `eval.py`) by an independent review pass before committing. A final end-to-end review confirmed all 8 items from the bug report pass. N/A for rollout evidence. Fixes: NVBug 6854088 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Signed-off-by: Marta Stepniewska-Dziubinska <martas@nvidia.com> Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com> Signed-off-by: NeMo Bot <nemo-bot@nvidia.com>
svcnvidia-nemo-ci
added
area:cli
Contributor
Author
|
/ok to test f29de18 |
Contributor
|
🌿 Preview your docs: https://nvidia-preview-pr-4219-f29de186de03.docs.buildwithfern.com/nemo/gym |
marta-sd
approved these changes
Oct 8, 2026
ananthsub
added a commit
that referenced
this pull request
Oct 12, 2026
## What Updates three pages in the v0.7.0 docs snapshot (`fern/versions/v0.7.0/pages/`) to match `r0.7.0`: - `reference/cli-commands.mdx` - `contribute/environments/new-environment.mdx` - `contribute/environments/index.mdx` Each file is copied verbatim from `fern/versions/latest/pages/` on `r0.7.0`. ## Why The snapshot in #4207 was copied from the release branch before two docs fixes merged to `main` and were cherry-picked into `r0.7.0`: - NVBug 6854088, `cli-commands.mdx`: #4093, cherry-picked in #4219 - NVBug 6853090, `new-environment.mdx` and `environments/index.mdx`: #4175, cherry-picked in #4246 The 0.7.0 release includes both fixes, but the published v0.7.0 docs do not, because the snapshot on `main` was never refreshed. No issue: this corrects a stale copy of already-reviewed content. ## Validation - Each of the three snapshot files on `main` was byte-identical to its `r0.7.0` counterpart from before the fixes, which confirms the snapshot predates them. - After this change, `diff -r` between `r0.7.0`'s `fern/versions/latest/pages` and `fern/versions/v0.7.0/pages` reports no differences. - `python3 tests/unit_tests/test_fern_docs_links.py` passes. - `npm run check` in `fern/` reports no errors. Its one warning says the missing-redirects check was skipped without a Fern token; CI runs it with a token. ## Rollout evidence N/A: docs-only change. ## Impact After merge, the docs publish on `main` updates the v0.7.0 pages on the Fern site. This does not affect the `docs.nvidia.com/nemo/gym` 404, which comes from the custom-domain routing and also affects other Fern-hosted NeMo docs. Signed-off-by: Ananth Subramaniam <ansubramania@nvidia.com>
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.
beep boop [🤖]: Hi @marta-sd 👋,