[VDR] TUT-a28798eb · Single-step tutorial's env.yaml recipe fails: OPENAI_API_KEY is never read
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.2k
- Forks
- 349
- Avg merge
- 1d 23h
- Merged PRs (30d)
- 324
Description
Section 6 tells you to write openai_api_key: ??? into env.yaml and then, in a Tip, to export OPENAI_API_KEY="sk-...". Nothing in the codebase reads OPENAI_API_KEY — grep finds it only inside these four doc versions. ??? is an OmegaConf mandatory-missing marker, and raise_on_missing_values() in nemo_gym/global_config.py:401 aborts the run. Following the tutorial verbatim makes every subsequent step (gym env start, gym eval run) fail before any server starts.
Suggested fix: Either write the literal openai_api_key: ${oc.env:OPENAI_API_KEY} in the env.yaml snippet, or drop the export Tip and tell users to paste the key value into env.yaml (or pass --model-api-key, which does work — verified).
Details
| Severity | 🟠 high |
| Path | fern/versions/latest/pages/environment-tutorials/single-step-environment.mdx:431 |
| Finding ID | TUT-a28798eb |
| Found by | tutorial-walker |
| Workstream | [VDR][v0.5.0] Tutorials fail when followed verbatim |
| Status | New in this review |
Evidence
$ gym env resolve --config ... -> Error: 1 required config value(s) are unset (still '???') after merging: - openai_api_key (with OPENAI_API_KEY exported)
DX review Gym-1-20260730170035 · target ref e446e4f4 · 2026-07-30 · tracker #2214
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at fern/versions/latest/pages/environment-tutorials/single-step-environment.mdx:431 and compare the env.yaml snippet with the Tip about OPENAI_API_KEY. Check nemo_gym/global_config.py:401 and the documented gym env resolve, gym env start, and gym eval run flow. Done means the tutorial's documented environment-variable path resolves the key and subsequent commands no longer fail before a server starts.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python, yaml
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Active
- Clarity
- Clearly specified
- Newbie friendliness
- 91/100