Skip to content

docs: link training tutorials under the /tutorials/ section prefix - #2317

Merged
ananthsub merged 1 commit into
NVIDIA-NeMo:mainfrom
ananthsub:ananthsub/docs-tutorials-slug
Aug 4, 2026
Merged

docs: link training tutorials under the /tutorials/ section prefix#2317
ananthsub merged 1 commit into
NVIDIA-NeMo:mainfrom
ananthsub:ananthsub/docs-tutorials-slug

Conversation

@ananthsub

@ananthsub ananthsub commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

fern/versions/main.yml puts training-tutorials and evaluation-tutorials in the same section: Tutorials, so both publish under /tutorials/. Evaluation tutorials are already linked that way. Training tutorials are not.

Against the published site:

/nemo/gym/tutorials/training-tutorials/nemo-rl-grpo/   200
/nemo/gym/training-tutorials/nemo-rl-grpo/             308 -> /tutorials/training-tutorials/nemo-rl-grpo
/nemo/gym/tutorials/evaluation-tutorials/evalplus/     200
/nemo/gym/evaluation-tutorials/evalplus/               404

The old training form works, but only because Fern redirects it. The evaluation form has no such redirect. Having two sibling folders under one section linked two different ways makes the prefix look optional, and it isn't

@copy-pr-bot

copy-pr-bot Bot commented Aug 4, 2026

Copy link
Copy Markdown

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@ananthsub
ananthsub requested a review from lbliii August 4, 2026 15:17
@ananthsub ananthsub added documentation Improvements to documentation r0.5.0 Auto-cherrypick to release branch. Apply before merge; cherrypick happens after merge. labels Aug 4, 2026
@ananthsub
ananthsub marked this pull request as ready for review August 4, 2026 15:17
fern/versions/main.yml puts training-tutorials and evaluation-tutorials in the
same `section: Tutorials`, so both publish under /tutorials/. Evaluation
tutorials are already linked that way; training tutorials were not.

    /nemo/gym/tutorials/training-tutorials/nemo-rl-grpo/  200
    /nemo/gym/training-tutorials/nemo-rl-grpo/            308 -> /tutorials/...

The old form works, but only because Fern redirects it, and having two sibling
folders under one section linked two different ways makes the prefix look
optional. It is not: /evaluation-tutorials/... has no redirect and returns 404.

Rewrites 52 links across 23 pages in `latest`. Every distinct target was checked
against the published site and returns 200. Frozen versions are unchanged.

The new check in test_fern_docs_links.py asserts no link omits the prefix rather
than pinning an exact count, since a fixed total would need editing whenever a
tutorial gains a cross-reference.

Signed-off-by: Ananth Subramaniam <ansubramania@nvidia.com>
@ananthsub
ananthsub force-pushed the ananthsub/docs-tutorials-slug branch from d74c56c to e46fba7 Compare August 4, 2026 19:07
@ananthsub
ananthsub enabled auto-merge (squash) August 4, 2026 19:07
@ananthsub
ananthsub merged commit b428139 into NVIDIA-NeMo:main Aug 4, 2026
15 checks passed
@ananthsub
ananthsub deleted the ananthsub/docs-tutorials-slug branch August 5, 2026 15:50
OlegSudakov pushed a commit to OlegSudakov/Gym that referenced this pull request Aug 7, 2026
…VIDIA-NeMo#2317)

`fern/versions/main.yml` puts `training-tutorials` and
`evaluation-tutorials` in the same `section: Tutorials`, so both publish
under `/tutorials/`. Evaluation tutorials are already linked that way.
Training tutorials are not.

Against the published site:

```
/nemo/gym/tutorials/training-tutorials/nemo-rl-grpo/   200
/nemo/gym/training-tutorials/nemo-rl-grpo/             308 -> /tutorials/training-tutorials/nemo-rl-grpo
/nemo/gym/tutorials/evaluation-tutorials/evalplus/     200
/nemo/gym/evaluation-tutorials/evalplus/               404
```

The old training form works, but only because Fern redirects it. The
evaluation form has no such redirect. Having two sibling folders under
one section linked two different ways makes the prefix look optional,
and it isn't

Signed-off-by: Ananth Subramaniam <ansubramania@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements to documentation r0.5.0 Auto-cherrypick to release branch. Apply before merge; cherrypick happens after merge.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants