--- name: nemo-gym-docs description: > Maintain the NeMo Gym Fern docs site — add, update, move, or remove pages under fern/. Use for any documentation change. Triggered by: "edit docs", "add doc page", "update docs", "rename page", "fix broken link", "add redirect", "preview docs", "publish docs", any request that touches `fern/`. --- # NeMo Gym Docs Maintenance Unified skill for adding, updating, moving, and removing pages on the NeMo Gym Fern documentation site. ## Scope Rule **ALL docs edits happen under `fern/`.** All new pages — including release notes and migration guides — belong under `fern/`. **Bleeding-edge tree + GA snapshots.** Gym keeps one bleeding-edge content tree at `fern/versions/latest/` (the folder name is historical — it's mounted under the `main` slug via `main.yml`) and one frozen GA snapshot per shipped release (currently `fern/versions/v0.2.1/`). All new edits land in `fern/versions/latest/`. The `latest.yml` file is a GA *alias* — a symlink to the current GA's yml — so `/latest/...` and `//...` serve the same pages. Back-ports into a frozen GA snapshot are deliberate and rare; default to editing `fern/versions/latest/` only. ## Layout at a Glance ``` fern/ ├── fern.config.json # Org + Fern CLI version (currently 4.80.3) ├── package.json # `npm run dev|check|generate` — wraps `npx -y fern-api@latest` ├── docs.yml # Site config: instances, versions, tabs, redirects, libraries ├── versions/ │ ├── latest.yml # GA alias — symlink to the current GA's yml (currently v0.2.1.yml) │ ├── main.yml # Nav tree for the bleeding-edge train (mounts ./latest/pages) │ ├── latest/pages/ # MDX content for the bleeding-edge train (slug: main) │ ├── v0.2.1.yml # Nav tree for the 0.2.1 GA snapshot │ └── v0.2.1/pages/ # MDX content for the 0.2.1 GA snapshot ├── components/ # Custom TSX (CTAButtons, NavButton, CustomFooter) ├── assets/ # Images, SVGs, favicon ├── main.css # Global theme overrides (NVIDIA green, badge spacing, etc.) └── product-docs/ # GENERATED library reference (gitignored) ``` ``` File system Published URL ───────────────────────────────────────────────────── ────────────────────────────────── fern/versions/latest/pages/get-started/quickstart.mdx docs.nvidia.com/nemo/gym/main/get-started/quickstart fern/versions/v0.2.1/pages/get-started/quickstart.mdx docs.nvidia.com/nemo/gym/v0.2.1/get-started/quickstart docs.nvidia.com/nemo/gym/latest/get-started/quickstart (GA alias) ``` ## Operations ### Add a Page 1. Gather: page title, target section, filename (kebab-case `.mdx`), subdirectory under `fern/versions/latest/pages/`. 2. Create `fern/versions/latest/pages//.mdx`: ```mdx --- title: "" description: "One-line SEO description (or empty string)" position: 3 --- # ``` 3. If the parent folder is mounted in `main.yml` with `title-source: frontmatter`, the page is auto-discovered — no nav edit needed. Otherwise add a `- page:` entry under the right `section:` in `fern/versions/main.yml`. 4. Do **not** mirror into the current GA snapshot folder (e.g., `v0.2.1/`) — frozen GA snapshots only get back-ports on explicit request. ### Update a Page 1. Locate by path, title, or keyword (`grep -rn` in `fern/versions/latest/pages/`). 2. **Content only** — edit the MDX in `fern/versions/latest/pages/`. Don't touch `v0.2.1/` unless this is an explicit back-port. 3. **Title change** — update the frontmatter `title:` and (if the parent uses `title-source: frontmatter`) nothing else; otherwise update the nav `- page:` entry too. 4. **Section move** — `git mv` the file, update its `path:` in `main.yml`, fix all incoming links inside `fern/versions/latest/pages/`. 5. **Slug change** — folders use the page filename for the slug. Renaming the file changes the URL; add a redirect in `fern/docs.yml` so the old URL keeps working. ### Remove a Page 1. Find incoming links: `grep -rn "" fern/versions/latest/pages --include="*.mdx"`. 2. `git rm` the file from `fern/versions/latest/pages/`. 3. Remove the matching `- page:` block from `main.yml` if it was a manual entry. 4. Fix or remove all incoming links. 5. Add a redirect in `fern/docs.yml` if the URL was public. ### Back-port to a GA Snapshot Only back-port when the user explicitly asks ("back-port to v0.2.1"). Apply the same change inside the GA snapshot's `pages/` folder (e.g., `fern/versions/v0.2.1/pages/`) and update its yml if needed. `latest.yml` is a symlink to the current GA's yml, so nav changes propagate automatically. ### Worked Example: Adding a Page Request: *"Add a how-to for collecting rollouts under Get Started."* 1. Create `fern/versions/latest/pages/get-started/rollout-collection.mdx`: ```mdx --- title: "Collect Rollouts" description: "Run the agent against your dataset and write results to JSONL" position: 4 --- # Collect Rollouts ``` 2. The `get-started` folder in `main.yml` uses `title-source: frontmatter`, so the page appears automatically. `position: 4` controls ordering — it's optional; without it, pages sort alphabetically by filename. 3. `cd fern && npm run check && npm run dev`, verify `/main/get-started/rollout-collection` renders. ### Worked Example: Renaming a Slug (with Redirect) Request: *"Rename `/main/get-started/setup` to `/main/get-started/detailed-setup`."* 1. `git mv fern/versions/latest/pages/get-started/setup.mdx fern/versions/latest/pages/get-started/detailed-setup.mdx`. 2. Add a redirect in `fern/docs.yml`: ```yaml redirects: - source: "/main/get-started/setup" destination: "/main/get-started/detailed-setup" ``` 3. `grep -rn "/get-started/setup" fern/versions/latest/` and update any incoming links. --- ## Content Guidelines NeMo Gym uses **Fern-native MDX components directly**. Do not use GitHub `> [!NOTE]` syntax — it will not render. | Purpose | Component | |---|---| | Neutral aside | `...` | | Helpful tip | `...` | | Informational callout | `...` | | Warning | `...` | | Error / danger | `...` | | Card grid on index pages | `` with `` children | | Status/scope tag inside a Card | `tag` (see below) | Images live in `fern/assets/` (shared) or under a version's `pages/` (version-scoped). Reference with root-relative paths. ### Cards and Badges Index pages use a `` grid. Each `` can carry one or more `` tags to indicate scope, status, or read-time. Valid intents: `success`, `note`, `tip`, `warning`, `error`, `info`, `launch`, `check`. Use `...` (no intent) for neutral tags. Place badges as the last line inside the ``, separated by a blank line from the body text. The CSS in `main.css` (`.fern-card .fern-docs-badge`) handles spacing — do not add inline `style=` props. ```mdx Install, start servers, and collect your first rollouts in one page. start here 5 min ``` ## Frontmatter Fields ```yaml --- title: "" # required — used for nav and

description: "" # required (may be empty string) — SEO position: 1 # optional — orders auto-discovered pages within a folder --- ``` The MDX body should still open with `# ` matching the frontmatter title. Folders using `title-source: frontmatter` in the version YAML pull the nav label from `title:`. ## Validate First-time setup: authenticate the CLI against the `nvidia` Fern org via Google SSO (one-time, browser flow): ```bash npx -y fern-api@latest login # opens browser → sign in with your @nvidia.com Google account ``` Run from `fern/` (no install step — scripts shell out to `npx -y fern-api@latest`): ```bash npm run check # `fern check` — YAML + frontmatter validation npm run dev # `fern docs dev` — localhost:3000 hot-reload preview ``` `fern check` must pass before commit. The dev server's broken-link warnings for cross-version links like `/latest/about` are **false positives** — Fern's local validator does not resolve the version slug from `docs.yml` against `latest.yml`. The published site renders them correctly. To regenerate the autodoc library reference (gitignored under `product-docs/`): ```bash npm run generate:library # `fern docs md generate` ``` ## Commit & Preview ```bash git add fern/ git commit -s -m "docs: " ``` PRs that touch `fern/**` get an automatic Fern preview URL posted as a comment by `.github/workflows/fern-docs-preview-comment.yml`. No manual step needed. ``` ┌─ fern-docs-ci.yml → fern check PR (touches fern/) ─┼─ fern-docs-preview-build.yml → upload fern/ artifact (no secrets) └─ fern-docs-preview-comment.yml → 🌿 preview URL comment Push to main (touches docs/** or fern/**) → publish-fern-docs.yml → docs.nvidia.com/nemo/gym Tag push (docs/v*) → publish-fern-docs.yml → docs.nvidia.com/nemo/gym Manual dispatch → publish-fern-docs.yml → docs.nvidia.com/nemo/gym ``` The preview-comment + publish jobs require the `DOCS_FERN_TOKEN` repository or organization secret (from `fern token`). ## Publishing to Production Production publishes on three triggers (see `.github/workflows/publish-fern-docs.yml`): 1. **Push to `main`** when `docs/**` or `fern/**` changes — continuous staging. 2. **Tag push** matching `docs/v*` — versioned release. 3. **Manual dispatch** from the Actions tab. Tag format must be `docs/v..`. Do not push a tag unless the user asks. ```bash git tag docs/v0.3.0 git push origin docs/v0.3.0 ``` URL → version mapping: ``` docs.nvidia.com/nemo/gym/latest/... → GA alias (currently mirrors v0.2.1) docs.nvidia.com/nemo/gym/main/... → bleeding-edge train (folder: ./latest/pages) docs.nvidia.com/nemo/gym/v0.2.1/... → 0.2.1 GA snapshot ``` ## Cutting a New Version Train When the user ships a new version (e.g. `v0.3.0`): 1. `cp -r fern/versions/latest fern/versions/v0.3.0` — frozen snapshot of the bleeding-edge folder. 2. `cp fern/versions/main.yml fern/versions/v0.3.0.yml` and rewrite `./latest/` path prefixes to `./v0.3.0/`. 3. Retarget the `fern/versions/latest.yml` symlink at the new GA's yml: `cd fern/versions && ln -sfn v0.3.0.yml latest.yml`. 4. In `fern/docs.yml` `versions:`, add the new GA snapshot entry (`display-name: "0.3.0"`, `slug: v0.3.0`, `availability: stable`) and demote/remove the previous GA snapshot per the support policy. 5. `fern/versions/latest/pages/` keeps moving forward as the bleeding-edge tree. `main.yml` is unchanged. 6. Tag `docs/v0.3.0` and push to publish. ## Debugging | Symptom | Fix | |---|---| | `fern check` YAML error | 2-space indent; `- page:` inside `contents:`; `path:` is relative to the version YAML file | | Page 404 in preview | `slug:` missing/duplicated in the same section; or `position:` collision in an auto-discovered folder | | Broken-link warning for `/latest/...` cross-version link | False positive in `fern docs dev`; works on published site | | `JSX expressions must have one parent element` | Wrap multi-element MDX content in `<>...` or a `
` | | Old URL breaks (page renamed/moved) | Add a `redirects:` entry in `fern/docs.yml` | | Library reference missing | `npm run generate:library` in `fern/` | | Broken image | Path is relative to the MDX file; check `fern/assets/` exists | | Card badges have no spacing | Don't add inline styles — `main.css` `.fern-card .fern-docs-badge` rules handle it | | `/latest/` and `//` show different content | They shouldn't — `latest.yml` should mirror the current GA version's yml and point at the same `.//pages/...` content. Sync them. | ## Key References | File | Purpose | |---|---| | `fern/docs.yml` | Site config, versions, redirects, libraries | | `fern/versions/latest.yml` | GA alias — symlink to the current GA's yml | | `fern/versions/main.yml` | Nav tree for the bleeding-edge train (mounts `./latest/pages`) | | `fern/versions/v0.2.1.yml` | Nav tree for the 0.2.1 GA snapshot | | `fern/versions//pages/` | MDX content for a version | | `fern/components/` | Custom TSX (CTAButtons, NavButton, CustomFooter) | | `fern/assets/` | Shared images, SVGs, favicon | | `fern/main.css` | Global theme overrides — NVIDIA green, card/badge spacing | | `fern/package.json` | `npm run check|dev|generate|generate:library` — each wraps `npx -y fern-api@latest` | | `.github/workflows/fern-docs-*.yml` | CI: check, preview build, preview comment | | `.github/workflows/publish-fern-docs.yml` | CI: publish to docs.nvidia.com/nemo/gym | --- --- Source attribution: yo-steven Original project: https://github.com/yo-steven/skills-exploration-20260522/blob/6e1127ffb7690aa8038b172d0ae7cc720754870d/skills/NeMo-Gym/nemo-gym-docs/SKILL.md License: Apache-2.0 License information: https://www.apache.org/licenses/LICENSE-2.0 Original upstream instructions; downloaded from Dave AI. ## Upstream license notice SPDX-License-Identifier: Apache-2.0 AND CC-BY-4.0 Copyright (c) 2026 NVIDIA Corporation This project is licensed under a dual license: - Apache License 2.0 (for code and configuration) - Creative Commons Attribution 4.0 International (CC BY 4.0) (for documentation) You may use the contents of this repository under the terms of either license, or both, as applicable to the type of content. ================================================================================ Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to the Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by the Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding any notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS ================================================================================ Creative Commons Attribution 4.0 International License (CC BY 4.0) https://creativecommons.org/licenses/by/4.0/ You are free to: Share — copy and redistribute the material in any medium or format for any purpose, even commercially. Adapt — remix, transform, and build upon the material for any purpose, even commercially. The licensor cannot revoke these freedoms as long as you follow the license terms. Under the following terms: Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use. No additional restrictions — You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits. Notices: You do not have to comply with the license for elements of the material in the public domain or where your use is permitted by an applicable exception or limitation. No warranties are given. The license may not give you all of the permissions necessary for your intended use. For example, other rights such as publicity, privacy, or moral rights may limit how you use the material. For the full legal text, see: https://creativecommons.org/licenses/by/4.0/legalcode # Dave AI resource metadata Creator / publisher: yo-steven Original project: https://github.com/yo-steven/skills-exploration-20260522/blob/6e1127ffb7690aa8038b172d0ae7cc720754870d/skills/NeMo-Gym/nemo-gym-docs/SKILL.md Attribution basis: Source repository record Fields of work: Content & Media, Design, Product Management Roles: Product Manager, Technical Writer, UX Writer Specialties: Word Documents Tools: Tool not specified Country applicability: Country not specified Classification basis: Source catalog labels Instruction SHA-256: e13bffc0a6c1800daabfd7fcbb1f75e8fdac6424d21c4f1b850316da830ed79e