docs: fix fern docs issues from NVBugs 6193091#1393
Open
lbliii wants to merge 3 commits into
Open
Conversation
- about/concepts/index.mdx: add # Concepts heading; fix 404 link from
/about/concepts/environments-for-eval to /about/concepts/evaluation
- training-tutorials/nemo-rl-grpo/{index,about-workplace-assistant}.mdx
and training-tutorials/offline-training-w-rollouts.mdx: remove
malformed **** bold markers
- nemo-rl-grpo/about-workplace-assistant.mdx: replace broken in-page
anchor #training-nemo-rl-grpo-index with cross-page link
- integrate-external-environments.mdx: fix grammar and replace pinned
SHA URLs with clean main-branch links
- data/{index,prompt-config}.mdx: "Cli Commands" -> "CLI Commands"
- troubleshooting/configuration.mdx: add missing "See the" before
configuration reference link
- environment-tutorials/index.mdx: add card grid entries for
Integrate External Libraries, Add a Benchmark, and Aggregate Metrics
- reference/faq.mdx: standardize "Hugging Face" and "GitLab"
- standardize "LLM-as-Judge" casing across concepts, tutorials, and
verification-patterns pages
Signed-off-by: Lawrence Lane <[email protected]>
Fern renders the page H1 from frontmatter `title:` — adding `# Title` in the body produces a duplicate heading on the published site. - Add fern/AGENTS.md documenting the rule plus a few other recurring conventions (callout components, main-branch URLs, product-name casing, `fern check` before commit). - Revert the `# Concepts` heading I added to about/concepts/index.mdx in the previous commit; the original bug report was mistaken about the convention. Signed-off-by: Lawrence Lane <[email protected]>
Signed-off-by: Lawrence Lane <[email protected]>
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
1 participant
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.
Summary
Triage and fixes for the docs issues reported in NVBugs 6193091 ([NeMo Gym][H100][main][Docs] fern docs issues).
Critical fixes
about/concepts/index.mdxEvaluation card pointed to/about/concepts/environments-for-eval(no such page); corrected to/about/concepts/evaluation.****bold markers — removed intraining-tutorials/nemo-rl-grpo/index.mdx,training-tutorials/nemo-rl-grpo/about-workplace-assistant.mdx, andtraining-tutorials/offline-training-w-rollouts.mdx.#training-nemo-rl-grpo-indexinabout-workplace-assistant.mdxreplaced with a cross-page link to/training-tutorials/nemo-rl-grpo.integrate-external-environments.mdx"the appropriate level to integrate into are NeMo Gym agent servers" rewritten.\#L64,simple\_agent) inintegrate-external-environments.mdxreplaced with cleanmain-branch URLs;troubleshooting/configuration.mdxNote now reads "See the [Configuration reference]…".Clicasing —data/index.mdxanddata/prompt-config.mdxupdated toCLI Commands.Discoverability
environment-tutorials/index.mdxfor the three orphan tutorials (Integrate External Libraries, Add a Benchmark, Aggregate Metrics) so the grid matches the sidebar nav.Naming consistency
reference/faq.mdx: standardized to Hugging Face and GitLab (was a mix ofHuggingface/HuggingFace/huggingfaceandGitlab).about/concepts/environments.mdx,about/concepts/evaluation.mdx,environment-tutorials/index.mdx,environment-tutorials/single-step-environment.mdx, andenvironment-tutorials/verification-patterns/llm-as-judge.mdx.Issues from the report that did not need fixes
product_overview.pngand the three concept diagrams (eval-improve-loop.png,model-vs-agent-eval.png,env-training-library.png) all exist infern/assets/images/— likely added after the bug was filed (PR docs: add environment concepts pages #1265).Test plan
cd fern && npm run check— passes with 0 errors/main/about/conceptsrenders with an H1 and the Evaluation card lands on/main/about/concepts/evaluation/main/training-tutorials/nemo-rl-grpoand its child pages render with clean bold (no stray**)/main/environment-tutorialscard grid lists all 8 tutorials/main/reference/faqconsistently uses "Hugging Face" and "GitLab"/main/training-tutorials/nemo-rl-grpo/about-workplace-assistantPrerequisites link goes to the tutorial overviewRefs: NVBugs 6193091