docs: Edits for template alignment#85
Conversation
- Convert overview headings to title case and restructure the About overview to the tech-docs About template (Benefits, Use Cases, Core Workflow, Learn More) - Move the source-build Quick Start into a dedicated Getting Started page - Rename nav labels (Install -> Installation, Quickstart -> Beginner Tutorial) and add a Quickstart page; pin slugs so existing URLs are stable - Scaffold the Release Notes page from the tech-docs release-notes template Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Signed-off-by: Linette Tang <lvojktu@nvidia.com>
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
WalkthroughNeMo Fabric documentation was reorganized with updated overview content, a new quick-start page, renamed Getting Started entries, revised navigation, and a structured release-notes template. ChangesDocumentation updates
Estimated code review effort: 3 (Moderate) | ~20 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Replace the concept bullets with the five-step workflow (Configure, Create variants, Plan and diagnose, Run or start a runtime, Consume evidence) with bold lead-ins. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Signed-off-by: Linette Tang <lvojktu@nvidia.com>
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/about-nemo-fabric/overview.mdx (1)
77-108: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winShould Fix — Add a Lead-In for the Workflow List
The list at Line 98 follows the diagram without a sentence introducing it. Add a lead-in such as “This workflow has four stages:” immediately before the list. As per coding guidelines, introduce lists with complete lead-in sentences.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/about-nemo-fabric/overview.mdx` around lines 77 - 108, Add a complete lead-in sentence such as “This workflow has four stages:” immediately before the four-item workflow list following the Core Workflow diagram. Keep the existing list content unchanged.Source: Coding guidelines
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/about-nemo-fabric/overview.mdx`:
- Line 71: Update the “Platform And Evaluation Harnesses” heading to use
consistent title case, lowercasing the conjunction “And” while preserving the
heading level and wording.
In `@docs/about-nemo-fabric/release-notes.mdx`:
- Around line 26-28: Update the lists under “Support Matrix and Compatibility
Updates,” “Release Notes for Previous Versions,” and “Related Topics” with
complete introductory lead-in sentences before their bullet items. Keep the
existing list content intact and ensure each lead-in clearly introduces the
items that follow.
- Line 10: Correct the NeMo Fabric overview link in the release-notes content to
use the `/about-nemo-fabric/overview` slug, matching the route defined in
`docs/index.yml`.
In `@docs/getting-started/quick-start.mdx`:
- Around line 9-35: Add an initial prerequisites step to the quick-start
documentation linking to the Installation guide and explicitly requiring Rust
with Cargo and uv before their commands are used. Clarify that just build-all
must be run from the source-checkout root, while preserving the existing setup
sequence and commands.
---
Outside diff comments:
In `@docs/about-nemo-fabric/overview.mdx`:
- Around line 77-108: Add a complete lead-in sentence such as “This workflow has
four stages:” immediately before the four-item workflow list following the Core
Workflow diagram. Keep the existing list content unchanged.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Enterprise
Run ID: 87e8db02-75d9-4476-9ff6-d3cc03cb7134
📒 Files selected for processing (6)
docs/about-nemo-fabric/overview.mdxdocs/about-nemo-fabric/release-notes.mdxdocs/getting-started/install.mdxdocs/getting-started/quick-start.mdxdocs/getting-started/quickstart.mdxdocs/index.yml
📜 Review details
⏰ Context from checks skipped due to timeout. (10)
- GitHub Check: Test (Python 3.12, arm64)
- GitHub Check: Test (Python 3.14, arm64)
- GitHub Check: Test (Python 3.14, x86_64)
- GitHub Check: Test (Python 3.12, x86_64)
- GitHub Check: Test (Python 3.11, arm64)
- GitHub Check: Test (Python 3.13, arm64)
- GitHub Check: Test (Python 3.11, x86_64)
- GitHub Check: Test (Python 3.13, x86_64)
- GitHub Check: Build wheels (x86_64)
- GitHub Check: Pre-commit
🧰 Additional context used
📓 Path-based instructions (15)
**/*.{md,mdx,html}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Changes affecting public behavior, adapters, examples, or workspace structure must update the corresponding documentation; public API changes require updated SDK or API reference documentation.
Files:
docs/getting-started/install.mdxdocs/getting-started/quick-start.mdxdocs/getting-started/quickstart.mdxdocs/about-nemo-fabric/release-notes.mdxdocs/about-nemo-fabric/overview.mdx
**/*.{md,mdx}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
For docs site changes, run
just docsto regenerate Python and Rust API references and validate Fern configuration.
**/*.{md,mdx}: Prioritize factual accuracy in NeMo Fabric documentation and keep commands, package names, APIs, file paths, repository layout, entry points, support claims, examples, and procedures aligned with current repository behavior.
Update relevant entry-point documentation when public behavior changes, includingREADME.md,docs/index.yml, package or crate READMEs, and adapter or integration READMEs.
Use{/* ... */}delimiters for top-of-file SPDX comments in MDX files, not HTML comment delimiters.
CapitalizeNVIDIAcorrectly and use consistent current repository terminology, product names, APIs, and feature names.
Format commands, code, expressions, file names, paths, and filenames as inline code where appropriate.
Use title case for technical-documentation headings.
Introduce code blocks, tables, and lists with complete lead-in sentences.
Use descriptive link text instead of raw URLs or generic labels such ashere.
Write procedures as short, imperative, parallel, easy-to-scan steps; prefer active voice, present tense, plain English, and concise sentences.
Useafterinstead ofoncewhen expressing temporal sequence, and usecaninstead ofmaywhen describing possibility rather than permission.
Use unambiguous date formats and avoid ordinal dates in body text.
When reviewing documentation, report findings in severity order underMust fix,Should fix, andNice to have, with file paths, line references, explanations, and concrete rewrites or directions.
Files:
docs/getting-started/install.mdxdocs/getting-started/quick-start.mdxdocs/getting-started/quickstart.mdxdocs/about-nemo-fabric/release-notes.mdxdocs/about-nemo-fabric/overview.mdx
**/*
📄 CodeRabbit inference engine (CONTRIBUTING.md)
**/*: All source files must include the specified SPDX copyright and Apache-2.0 license header using the comment syntax appropriate to the file type.
Release tags must use raw Rust-compatible SemVer without a leadingv, such as0.1.0or0.1.0-rc.1.
**/*: Before implementing, explicitly state assumptions, surface ambiguity and tradeoffs, present multiple interpretations when relevant, and ask for clarification rather than silently deciding or proceeding when requirements are unclear.
Prefer the minimum code needed to solve the requested problem: avoid speculative features, unnecessary abstractions, unrequested flexibility, and handling of impossible scenarios; simplify overcomplicated solutions.
When editing existing code, make surgical changes only: do not modify unrelated code, comments, formatting, or pre-existing dead code; match the existing style, and remove only unused imports, variables, or functions introduced by your changes.
Define verifiable success criteria for each task, such as writing regression tests for bugs and invalid-input tests for validation, then verify the implementation against those criteria. For multi-step work, state a brief plan with a verification check for each step.
**/*: Keep pull request branch scope coherent and reviewable.
Run relevant tests undervalidate-changebefore opening or updating a pull request.
Format changed files with the language-native formatter.
Update documentation and examples for public behavior changes.
Update dependent maintainer or consumer guidance when code changes affect APIs, bindings, commands, paths, packaging guidance, or best practices.
Use Conventional Commit style for pull request titles:<type>: <concise imperative summary>, choosing the type from the actual change surface. Usefixonly for user-facing or runtime product-code bug fixes.
A pull request body must include#### Overview,#### Details,#### Validation,#### Where should the reviewer start?, and `#### Related ...
Files:
docs/getting-started/install.mdxdocs/getting-started/quick-start.mdxdocs/index.ymldocs/getting-started/quickstart.mdxdocs/about-nemo-fabric/release-notes.mdxdocs/about-nemo-fabric/overview.mdx
**/*.mdx
📄 CodeRabbit inference engine (CONTRIBUTING.md)
MDX files must use the specified SPDX header in a JSX comment.
In MDX files, use JSX comment delimiters (
{/*and*/}) for top-of-file comments, including SPDX headers; do not use HTML comments.
Files:
docs/getting-started/install.mdxdocs/getting-started/quick-start.mdxdocs/getting-started/quickstart.mdxdocs/about-nemo-fabric/release-notes.mdxdocs/about-nemo-fabric/overview.mdx
{README.md,docs/**/*.{md,mdx,yml},examples/**/*.{md,mdx,yml}}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Keep package names, repository references, and build commands current in documentation and examples.
Files:
docs/getting-started/install.mdxdocs/getting-started/quick-start.mdxdocs/index.ymldocs/getting-started/quickstart.mdxdocs/about-nemo-fabric/release-notes.mdxdocs/about-nemo-fabric/overview.mdx
{docs/**/*.{md,mdx,yml},examples/**/*.{md,mdx,yml}}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Update relevant getting-started, reference, adapter, and example documentation when the corresponding examples or adapters change.
Files:
docs/getting-started/install.mdxdocs/getting-started/quick-start.mdxdocs/index.ymldocs/getting-started/quickstart.mdxdocs/about-nemo-fabric/release-notes.mdxdocs/about-nemo-fabric/overview.mdx
docs/**/*.{md,mdx,yml}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Run
just docswhen the documentation site changes.
Files:
docs/getting-started/install.mdxdocs/getting-started/quick-start.mdxdocs/index.ymldocs/getting-started/quickstart.mdxdocs/about-nemo-fabric/release-notes.mdxdocs/about-nemo-fabric/overview.mdx
{docs/**/*,.github/workflows/ci_python.yml,.github/workflows/ci_rust.yml,justfile}
📄 CodeRabbit inference engine (.agents/skills/maintain-packaging/SKILL.md)
Use the current install, import, build, test, clean, and documentation commands consistently in documentation, examples, CI workflows, and just recipes.
Files:
docs/getting-started/install.mdxdocs/getting-started/quick-start.mdxdocs/index.ymldocs/getting-started/quickstart.mdxdocs/about-nemo-fabric/release-notes.mdxdocs/about-nemo-fabric/overview.mdx
{docs/**/*,.github/workflows/ci_python.yml,.github/workflows/ci_rust.yml}
📄 CodeRabbit inference engine (.agents/skills/maintain-packaging/SKILL.md)
Reflect public packaging changes in release-facing documentation and examples.
Files:
docs/getting-started/install.mdxdocs/getting-started/quick-start.mdxdocs/index.ymldocs/getting-started/quickstart.mdxdocs/about-nemo-fabric/release-notes.mdxdocs/about-nemo-fabric/overview.mdx
**/*.{md,mdx,rst}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
**/*.{md,mdx,rst}: For NeMo Fabric documentation, verify technical claims against the current repository, public API, or documented command before reviewing style.
Always spellNVIDIAin all caps; do not useNvidia,nvidia, orNV.
Format commands, code elements, expressions, package names, file names, and paths as inline code.
Use descriptive link text; avoid raw URLs and weak anchors such ashereorread more.
Use title case consistently for technical documentation headings.
Introduce code blocks, lists, tables, and images with complete sentences.
Write procedures as imperative, parallel steps; split long procedures into smaller tasks.
Prefer active voice, present tense, short sentences, contractions, and plain English while preserving necessary technical precision.
Usecanfor possibility and reservemayfor permission.
Useafterfor temporal relationships instead ofonce, and preferrefer tooverseewhen directing readers to another resource.
Avoid culture-specific idioms, unnecessary Latinisms, jokes, and marketing exaggeration in technical documentation.
Spell out months in body text, avoid ordinal dates, and use clear time zones.
Spell out whole numbers from zero through nine unless they are technical values, parameters, versions, or UI values; use numerals for 10 or greater and commas in thousands.
Do not add trademark symbols to learning-oriented documentation unless the source, platform, or legal guidance explicitly requires them.
Do not replace precise technical terms with simpler words when doing so would lose precision.
Do not flag passive voice when the actor is unknown or the action is the important part.
Do not rewrite API names, package names, command flags, or code literals for style.
**/*.{md,mdx,rst}: Use consistent title case for technical-document headings and table headers; avoid quotation marks, ampersands, and exclamation marks in headings, while preserving official product, event, research, and whitepaper title ...
Files:
docs/getting-started/install.mdxdocs/getting-started/quick-start.mdxdocs/getting-started/quickstart.mdxdocs/about-nemo-fabric/release-notes.mdxdocs/about-nemo-fabric/overview.mdx
docs/**/*
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
For documentation or examples changes, run
just docswhen practical and verify documented commands against the current repository.
Files:
docs/getting-started/install.mdxdocs/getting-started/quick-start.mdxdocs/index.ymldocs/getting-started/quickstart.mdxdocs/about-nemo-fabric/release-notes.mdxdocs/about-nemo-fabric/overview.mdx
{docs/**,README.md,AGENTS.md}
⚙️ CodeRabbit configuration file
{docs/**,README.md,AGENTS.md}: Review documentation for technical accuracy against the current API, command correctness, and consistency with generated schemas.
Files:
docs/getting-started/install.mdxdocs/getting-started/quick-start.mdxdocs/index.ymldocs/getting-started/quickstart.mdxdocs/about-nemo-fabric/release-notes.mdxdocs/about-nemo-fabric/overview.mdx
**/*.{toml,yaml,yml,sh,bash}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
TOML, YAML, and shell files must use the specified SPDX header with
#comments.
Files:
docs/index.yml
**/*.{rs,py,pyi,json,yaml,yml}
📄 CodeRabbit inference engine (.agents/skills/contribute-api/SKILL.md)
Determine and update every affected public surface, including the CLI, PyO3 bindings, Python SDK, type stubs, schemas, and adapter contract, so they remain in parity.
Files:
docs/index.yml
{README.md,docs/index.yml}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Update
README.mdordocs/index.ymlwhen documentation entry points or example reading paths change.
Files:
docs/index.yml
🔇 Additional comments (7)
docs/about-nemo-fabric/overview.mdx (2)
2-43: LGTM!
110-118: LGTM!docs/getting-started/install.mdx (1)
2-2: LGTM!docs/getting-started/quick-start.mdx (2)
1-8: LGTM!
38-66: LGTM!docs/getting-started/quickstart.mdx (1)
2-2: LGTM!docs/index.yml (1)
13-21: LGTM!
| SPDX-License-Identifier: Apache-2.0 */} | ||
|
|
||
| To be filled out at release time | ||
| This documentation contains the release notes for [NVIDIA NeMo Fabric](/about-ne-mo-fabric/overview). |
There was a problem hiding this comment.
🗄️ Data Integrity & Integration | 🟡 Minor | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Description: Verify the slug for the overview page in Fern configuration.
# Check docs.yml or index.yml for the overview page slug
rg -n 'about-ne-mo-fabric\|about-nemo-fabric' docs/index.yml docs/docs.yml 2>/dev/null || echo "No index/docs config found, check manually"
# Also verify the overview file exists
fd -i 'overview.mdx' docs/Repository: NVIDIA/NeMo-Fabric
Length of output: 235
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "== files of interest =="
git ls-files 'docs/**' 'README.md' | rg 'about-nemo-fabric|index\.yml|docs\.yml|fern|config|overview\.mdx|release-notes\.mdx'
echo
echo "== search for slug metadata =="
rg -n --hidden --glob '!**/node_modules/**' --glob '!**/.git/**' \
'about-ne-mo-fabric|about-nemo-fabric|slug:|permalink:|route:|path:' \
docs README.md . 2>/dev/null || true
echo
echo "== overview frontmatter =="
sed -n '1,80p' docs/about-nemo-fabric/overview.mdx
echo
echo "== release notes header =="
sed -n '1,60p' docs/about-nemo-fabric/release-notes.mdxRepository: NVIDIA/NeMo-Fabric
Length of output: 50375
🏁 Script executed:
#!/bin/bash
set -euo pipefail
printf '== relevant files ==\n'
git ls-files 'docs/about-nemo-fabric/*' 'docs/**/*' | rg 'about-nemo-fabric|fern|index\.yml|docs\.yml'
printf '\n== slug references ==\n'
rg -n --hidden --glob 'docs/**' --glob '!**/node_modules/**' \
'about-ne-mo-fabric|about-nemo-fabric|slug:|permalink:|route:|path:' \
docs 2>/dev/null | head -n 200
printf '\n== overview.mdx head ==\n'
sed -n '1,40p' docs/about-nemo-fabric/overview.mdx
printf '\n== release-notes.mdx head ==\n'
sed -n '1,30p' docs/about-nemo-fabric/release-notes.mdxRepository: NVIDIA/NeMo-Fabric
Length of output: 26192
🏁 Script executed:
#!/bin/bash
set -euo pipefail
printf '== fern / docs config files ==\n'
git ls-files | rg '(^|/)(fern.*|.*fern.*|docs\.yml|index\.yml|config\.yml|config\.yaml|site\.yml|site\.yaml)$'
printf '\n== slug / alias references in config files ==\n'
rg -n --hidden --glob '!**/node_modules/**' --glob '!**/.git/**' \
'about-ne-mo-fabric|about-nemo-fabric|slug:|alias:|aliases:|redirect|canonical' \
. 2>/dev/null | head -n 200
printf '\n== root docs-related config heads ==\n'
for f in $(git ls-files | rg '(^|/)(fern.*|.*fern.*|docs\.yml|index\.yml|config\.yml|config\.yaml|site\.yml|site\.yaml)$'); do
printf '\n--- %s ---\n' "$f"
sed -n '1,80p' "$f"
doneRepository: NVIDIA/NeMo-Fabric
Length of output: 50375
Fix the overview link slug. docs/about-nemo-fabric/release-notes.mdx:10 points to /about-ne-mo-fabric/overview, but the docs route is /about-nemo-fabric/overview in docs/index.yml.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/about-nemo-fabric/release-notes.mdx` at line 10, Correct the NeMo Fabric
overview link in the release-notes content to use the
`/about-nemo-fabric/overview` slug, matching the route defined in
`docs/index.yml`.
Source: Path instructions
| Install `just` 1.50.0+ if it is not already available. | ||
|
|
||
| ```bash | ||
| cargo install just --locked | ||
| ``` | ||
|
|
||
| Refer to the [official installation guide](https://just.systems/man/en/installation.html) | ||
| for more details. | ||
|
|
||
| Ensure that the Cargo bin directory is in your `PATH`: | ||
|
|
||
| ```bash | ||
| export PATH="$HOME/.cargo/bin:$PATH" | ||
| ``` | ||
|
|
||
| Create a Python virtual environment and activate it (replace `3.13` with your preferred Python version): | ||
|
|
||
| ```bash | ||
| uv venv -p 3.13 --seed .venv | ||
| source .venv/bin/activate | ||
| ``` | ||
|
|
||
| Install the Python SDK with its native binding and the CLI from a source | ||
| checkout: | ||
|
|
||
| ```bash | ||
| just build-all |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Should Fix — Document Required Setup Tools
Line 9 invokes cargo and Line 27 invokes uv, but neither prerequisite is established. Add an initial prerequisites step linking to Installation, explicitly requiring Rust with Cargo and uv, and state that just build-all runs from the source-checkout root. As per coding guidelines, keep documented commands aligned with current repository behavior and write complete procedures.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/getting-started/quick-start.mdx` around lines 9 - 35, Add an initial
prerequisites step to the quick-start documentation linking to the Installation
guide and explicitly requiring Rust with Cargo and uv before their commands are
used. Clarify that just build-all must be run from the source-checkout root,
while preserving the existing setup sequence and commands.
Sources: Coding guidelines, Path instructions
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/about-nemo-fabric/overview.mdx`:
- Around line 100-102: Update the “Create variants” documentation sentence to
use “can” instead of “may” when describing file-backed packages applying ordered
profiles, without changing the surrounding guidance.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Enterprise
Run ID: 0d67419e-7982-47a5-8037-fd7bbe73a8e3
📒 Files selected for processing (1)
docs/about-nemo-fabric/overview.mdx
📜 Review details
⏰ Context from checks skipped due to timeout. (9)
- GitHub Check: Pre-commit
- GitHub Check: Test (Python 3.14, arm64)
- GitHub Check: Test (Python 3.13, arm64)
- GitHub Check: Test (Python 3.13, x86_64)
- GitHub Check: Test (Python 3.11, arm64)
- GitHub Check: Test (Python 3.11, x86_64)
- GitHub Check: Test (Python 3.12, arm64)
- GitHub Check: Test (Python 3.12, x86_64)
- GitHub Check: Test (Python 3.14, x86_64)
🧰 Additional context used
📓 Path-based instructions (12)
**/*.{md,mdx,html}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Changes affecting public behavior, adapters, examples, or workspace structure must update the corresponding documentation; public API changes require updated SDK or API reference documentation.
Files:
docs/about-nemo-fabric/overview.mdx
**/*.{md,mdx}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
For docs site changes, run
just docsto regenerate Python and Rust API references and validate Fern configuration.
**/*.{md,mdx}: Prioritize factual accuracy in NeMo Fabric documentation and keep commands, package names, APIs, file paths, repository layout, entry points, support claims, examples, and procedures aligned with current repository behavior.
Update relevant entry-point documentation when public behavior changes, includingREADME.md,docs/index.yml, package or crate READMEs, and adapter or integration READMEs.
Use{/* ... */}delimiters for top-of-file SPDX comments in MDX files, not HTML comment delimiters.
CapitalizeNVIDIAcorrectly and use consistent current repository terminology, product names, APIs, and feature names.
Format commands, code, expressions, file names, paths, and filenames as inline code where appropriate.
Use title case for technical-documentation headings.
Introduce code blocks, tables, and lists with complete lead-in sentences.
Use descriptive link text instead of raw URLs or generic labels such ashere.
Write procedures as short, imperative, parallel, easy-to-scan steps; prefer active voice, present tense, plain English, and concise sentences.
Useafterinstead ofoncewhen expressing temporal sequence, and usecaninstead ofmaywhen describing possibility rather than permission.
Use unambiguous date formats and avoid ordinal dates in body text.
When reviewing documentation, report findings in severity order underMust fix,Should fix, andNice to have, with file paths, line references, explanations, and concrete rewrites or directions.
Files:
docs/about-nemo-fabric/overview.mdx
**/*
📄 CodeRabbit inference engine (CONTRIBUTING.md)
**/*: All source files must include the specified SPDX copyright and Apache-2.0 license header using the comment syntax appropriate to the file type.
Release tags must use raw Rust-compatible SemVer without a leadingv, such as0.1.0or0.1.0-rc.1.
**/*: Before implementing, explicitly state assumptions, surface ambiguity and tradeoffs, present multiple interpretations when relevant, and ask for clarification rather than silently deciding or proceeding when requirements are unclear.
Prefer the minimum code needed to solve the requested problem: avoid speculative features, unnecessary abstractions, unrequested flexibility, and handling of impossible scenarios; simplify overcomplicated solutions.
When editing existing code, make surgical changes only: do not modify unrelated code, comments, formatting, or pre-existing dead code; match the existing style, and remove only unused imports, variables, or functions introduced by your changes.
Define verifiable success criteria for each task, such as writing regression tests for bugs and invalid-input tests for validation, then verify the implementation against those criteria. For multi-step work, state a brief plan with a verification check for each step.
**/*: Keep pull request branch scope coherent and reviewable.
Run relevant tests undervalidate-changebefore opening or updating a pull request.
Format changed files with the language-native formatter.
Update documentation and examples for public behavior changes.
Update dependent maintainer or consumer guidance when code changes affect APIs, bindings, commands, paths, packaging guidance, or best practices.
Use Conventional Commit style for pull request titles:<type>: <concise imperative summary>, choosing the type from the actual change surface. Usefixonly for user-facing or runtime product-code bug fixes.
A pull request body must include#### Overview,#### Details,#### Validation,#### Where should the reviewer start?, and `#### Related ...
Files:
docs/about-nemo-fabric/overview.mdx
**/*.mdx
📄 CodeRabbit inference engine (CONTRIBUTING.md)
MDX files must use the specified SPDX header in a JSX comment.
In MDX files, use JSX comment delimiters (
{/*and*/}) for top-of-file comments, including SPDX headers; do not use HTML comments.
Files:
docs/about-nemo-fabric/overview.mdx
{README.md,docs/**/*.{md,mdx,yml},examples/**/*.{md,mdx,yml}}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Keep package names, repository references, and build commands current in documentation and examples.
Files:
docs/about-nemo-fabric/overview.mdx
{docs/**/*.{md,mdx,yml},examples/**/*.{md,mdx,yml}}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Update relevant getting-started, reference, adapter, and example documentation when the corresponding examples or adapters change.
Files:
docs/about-nemo-fabric/overview.mdx
docs/**/*.{md,mdx,yml}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Run
just docswhen the documentation site changes.
Files:
docs/about-nemo-fabric/overview.mdx
{docs/**/*,.github/workflows/ci_python.yml,.github/workflows/ci_rust.yml,justfile}
📄 CodeRabbit inference engine (.agents/skills/maintain-packaging/SKILL.md)
Use the current install, import, build, test, clean, and documentation commands consistently in documentation, examples, CI workflows, and just recipes.
Files:
docs/about-nemo-fabric/overview.mdx
{docs/**/*,.github/workflows/ci_python.yml,.github/workflows/ci_rust.yml}
📄 CodeRabbit inference engine (.agents/skills/maintain-packaging/SKILL.md)
Reflect public packaging changes in release-facing documentation and examples.
Files:
docs/about-nemo-fabric/overview.mdx
**/*.{md,mdx,rst}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
**/*.{md,mdx,rst}: For NeMo Fabric documentation, verify technical claims against the current repository, public API, or documented command before reviewing style.
Always spellNVIDIAin all caps; do not useNvidia,nvidia, orNV.
Format commands, code elements, expressions, package names, file names, and paths as inline code.
Use descriptive link text; avoid raw URLs and weak anchors such ashereorread more.
Use title case consistently for technical documentation headings.
Introduce code blocks, lists, tables, and images with complete sentences.
Write procedures as imperative, parallel steps; split long procedures into smaller tasks.
Prefer active voice, present tense, short sentences, contractions, and plain English while preserving necessary technical precision.
Usecanfor possibility and reservemayfor permission.
Useafterfor temporal relationships instead ofonce, and preferrefer tooverseewhen directing readers to another resource.
Avoid culture-specific idioms, unnecessary Latinisms, jokes, and marketing exaggeration in technical documentation.
Spell out months in body text, avoid ordinal dates, and use clear time zones.
Spell out whole numbers from zero through nine unless they are technical values, parameters, versions, or UI values; use numerals for 10 or greater and commas in thousands.
Do not add trademark symbols to learning-oriented documentation unless the source, platform, or legal guidance explicitly requires them.
Do not replace precise technical terms with simpler words when doing so would lose precision.
Do not flag passive voice when the actor is unknown or the action is the important part.
Do not rewrite API names, package names, command flags, or code literals for style.
**/*.{md,mdx,rst}: Use consistent title case for technical-document headings and table headers; avoid quotation marks, ampersands, and exclamation marks in headings, while preserving official product, event, research, and whitepaper title ...
Files:
docs/about-nemo-fabric/overview.mdx
docs/**/*
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
For documentation or examples changes, run
just docswhen practical and verify documented commands against the current repository.
Files:
docs/about-nemo-fabric/overview.mdx
{docs/**,README.md,AGENTS.md}
⚙️ CodeRabbit configuration file
{docs/**,README.md,AGENTS.md}: Review documentation for technical accuracy against the current API, command correctness, and consistency with generated schemas.
Files:
docs/about-nemo-fabric/overview.mdx
- Lowercase the conjunction in the "Platform and Evaluation Harnesses" subheading for consistent title case - Restore the "Choose Your Interface" comparison table and place it above Core Workflow Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Signed-off-by: Linette Tang <lvojktu@nvidia.com>
lvojtku
changed the title
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/about-nemo-fabric/overview.mdx`:
- Around line 77-79: Insert a complete introductory sentence between the “Choose
Your Interface” heading and its table, briefly explaining what the table helps
readers choose. Keep the existing table unchanged.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Enterprise
Run ID: 1f789d4b-c690-4564-8de7-c57c463672e7
📒 Files selected for processing (1)
docs/about-nemo-fabric/overview.mdx
📜 Review details
⏰ Context from checks skipped due to timeout. (11)
- GitHub Check: Pre-commit
- GitHub Check: Test (Python 3.13, arm64)
- GitHub Check: Test (Python 3.12, arm64)
- GitHub Check: Test (Python 3.14, x86_64)
- GitHub Check: Test (Python 3.11, x86_64)
- GitHub Check: Test (Python 3.13, x86_64)
- GitHub Check: Test (Python 3.11, arm64)
- GitHub Check: Build wheels (arm64)
- GitHub Check: Test (Python 3.12, x86_64)
- GitHub Check: Test (Python 3.14, arm64)
- GitHub Check: Build wheels (x86_64)
🧰 Additional context used
📓 Path-based instructions (12)
**/*.{md,mdx,html}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Changes affecting public behavior, adapters, examples, or workspace structure must update the corresponding documentation; public API changes require updated SDK or API reference documentation.
Files:
docs/about-nemo-fabric/overview.mdx
**/*.{md,mdx}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
For docs site changes, run
just docsto regenerate Python and Rust API references and validate Fern configuration.
**/*.{md,mdx}: Prioritize factual accuracy in NeMo Fabric documentation and keep commands, package names, APIs, file paths, repository layout, entry points, support claims, examples, and procedures aligned with current repository behavior.
Update relevant entry-point documentation when public behavior changes, includingREADME.md,docs/index.yml, package or crate READMEs, and adapter or integration READMEs.
Use{/* ... */}delimiters for top-of-file SPDX comments in MDX files, not HTML comment delimiters.
CapitalizeNVIDIAcorrectly and use consistent current repository terminology, product names, APIs, and feature names.
Format commands, code, expressions, file names, paths, and filenames as inline code where appropriate.
Use title case for technical-documentation headings.
Introduce code blocks, tables, and lists with complete lead-in sentences.
Use descriptive link text instead of raw URLs or generic labels such ashere.
Write procedures as short, imperative, parallel, easy-to-scan steps; prefer active voice, present tense, plain English, and concise sentences.
Useafterinstead ofoncewhen expressing temporal sequence, and usecaninstead ofmaywhen describing possibility rather than permission.
Use unambiguous date formats and avoid ordinal dates in body text.
When reviewing documentation, report findings in severity order underMust fix,Should fix, andNice to have, with file paths, line references, explanations, and concrete rewrites or directions.
Files:
docs/about-nemo-fabric/overview.mdx
**/*
📄 CodeRabbit inference engine (CONTRIBUTING.md)
**/*: All source files must include the specified SPDX copyright and Apache-2.0 license header using the comment syntax appropriate to the file type.
Release tags must use raw Rust-compatible SemVer without a leadingv, such as0.1.0or0.1.0-rc.1.
**/*: Before implementing, explicitly state assumptions, surface ambiguity and tradeoffs, present multiple interpretations when relevant, and ask for clarification rather than silently deciding or proceeding when requirements are unclear.
Prefer the minimum code needed to solve the requested problem: avoid speculative features, unnecessary abstractions, unrequested flexibility, and handling of impossible scenarios; simplify overcomplicated solutions.
When editing existing code, make surgical changes only: do not modify unrelated code, comments, formatting, or pre-existing dead code; match the existing style, and remove only unused imports, variables, or functions introduced by your changes.
Define verifiable success criteria for each task, such as writing regression tests for bugs and invalid-input tests for validation, then verify the implementation against those criteria. For multi-step work, state a brief plan with a verification check for each step.
**/*: Keep pull request branch scope coherent and reviewable.
Run relevant tests undervalidate-changebefore opening or updating a pull request.
Format changed files with the language-native formatter.
Update documentation and examples for public behavior changes.
Update dependent maintainer or consumer guidance when code changes affect APIs, bindings, commands, paths, packaging guidance, or best practices.
Use Conventional Commit style for pull request titles:<type>: <concise imperative summary>, choosing the type from the actual change surface. Usefixonly for user-facing or runtime product-code bug fixes.
A pull request body must include#### Overview,#### Details,#### Validation,#### Where should the reviewer start?, and `#### Related ...
Files:
docs/about-nemo-fabric/overview.mdx
**/*.mdx
📄 CodeRabbit inference engine (CONTRIBUTING.md)
MDX files must use the specified SPDX header in a JSX comment.
In MDX files, use JSX comment delimiters (
{/*and*/}) for top-of-file comments, including SPDX headers; do not use HTML comments.
Files:
docs/about-nemo-fabric/overview.mdx
{README.md,docs/**/*.{md,mdx,yml},examples/**/*.{md,mdx,yml}}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Keep package names, repository references, and build commands current in documentation and examples.
Files:
docs/about-nemo-fabric/overview.mdx
{docs/**/*.{md,mdx,yml},examples/**/*.{md,mdx,yml}}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Update relevant getting-started, reference, adapter, and example documentation when the corresponding examples or adapters change.
Files:
docs/about-nemo-fabric/overview.mdx
docs/**/*.{md,mdx,yml}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Run
just docswhen the documentation site changes.
Files:
docs/about-nemo-fabric/overview.mdx
{docs/**/*,.github/workflows/ci_python.yml,.github/workflows/ci_rust.yml,justfile}
📄 CodeRabbit inference engine (.agents/skills/maintain-packaging/SKILL.md)
Use the current install, import, build, test, clean, and documentation commands consistently in documentation, examples, CI workflows, and just recipes.
Files:
docs/about-nemo-fabric/overview.mdx
{docs/**/*,.github/workflows/ci_python.yml,.github/workflows/ci_rust.yml}
📄 CodeRabbit inference engine (.agents/skills/maintain-packaging/SKILL.md)
Reflect public packaging changes in release-facing documentation and examples.
Files:
docs/about-nemo-fabric/overview.mdx
**/*.{md,mdx,rst}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
**/*.{md,mdx,rst}: For NeMo Fabric documentation, verify technical claims against the current repository, public API, or documented command before reviewing style.
Always spellNVIDIAin all caps; do not useNvidia,nvidia, orNV.
Format commands, code elements, expressions, package names, file names, and paths as inline code.
Use descriptive link text; avoid raw URLs and weak anchors such ashereorread more.
Use title case consistently for technical documentation headings.
Introduce code blocks, lists, tables, and images with complete sentences.
Write procedures as imperative, parallel steps; split long procedures into smaller tasks.
Prefer active voice, present tense, short sentences, contractions, and plain English while preserving necessary technical precision.
Usecanfor possibility and reservemayfor permission.
Useafterfor temporal relationships instead ofonce, and preferrefer tooverseewhen directing readers to another resource.
Avoid culture-specific idioms, unnecessary Latinisms, jokes, and marketing exaggeration in technical documentation.
Spell out months in body text, avoid ordinal dates, and use clear time zones.
Spell out whole numbers from zero through nine unless they are technical values, parameters, versions, or UI values; use numerals for 10 or greater and commas in thousands.
Do not add trademark symbols to learning-oriented documentation unless the source, platform, or legal guidance explicitly requires them.
Do not replace precise technical terms with simpler words when doing so would lose precision.
Do not flag passive voice when the actor is unknown or the action is the important part.
Do not rewrite API names, package names, command flags, or code literals for style.
**/*.{md,mdx,rst}: Use consistent title case for technical-document headings and table headers; avoid quotation marks, ampersands, and exclamation marks in headings, while preserving official product, event, research, and whitepaper title ...
Files:
docs/about-nemo-fabric/overview.mdx
docs/**/*
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
For documentation or examples changes, run
just docswhen practical and verify documented commands against the current repository.
Files:
docs/about-nemo-fabric/overview.mdx
{docs/**,README.md,AGENTS.md}
⚙️ CodeRabbit configuration file
{docs/**,README.md,AGENTS.md}: Review documentation for technical accuracy against the current API, command correctness, and consistency with generated schemas.
Files:
docs/about-nemo-fabric/overview.mdx
Introduce lead-in sentences before the bullet lists under Support Matrix and Compatibility Updates, Release Notes for Previous Versions, and Related Topics, matching the other release-notes sections. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Signed-off-by: Linette Tang <lvojktu@nvidia.com>
lvojtku
changed the title
Co-authored-by: David Gardner <96306125+dagardner-nv@users.noreply.github.com>
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/about-nemo-fabric/release-notes.mdx (1)
12-15: 🎯 Functional Correctness | 🟠 Major | ⚡ Quick winReplace the release-note placeholders before publishing.
docs/about-nemo-fabric/release-notes.mdxstill contains placeholder release metadata and link targets (<Number.Number.Number>,<focus / soul / spirit of the release>,<platform>,N.N.N,doc.mdx,link.mdx,troubleshooting.mdx), so the published page will render incomplete content. Populate these with release-specific values and real page links, or keep this template out of the published docs.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/about-nemo-fabric/release-notes.mdx` around lines 12 - 15, Replace all release-note placeholders in the release-notes document with the actual release version, summary, platform, version references, and valid documentation links, including the heading and linked pages. If this file is intended only as a template, remove it from the published documentation instead.Sources: Coding guidelines, Path instructions
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Outside diff comments:
In `@docs/about-nemo-fabric/release-notes.mdx`:
- Around line 12-15: Replace all release-note placeholders in the release-notes
document with the actual release version, summary, platform, version references,
and valid documentation links, including the heading and linked pages. If this
file is intended only as a template, remove it from the published documentation
instead.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Enterprise
Run ID: 460f7863-2337-446a-a4d6-f04f4e8b7785
📒 Files selected for processing (1)
docs/about-nemo-fabric/release-notes.mdx
📜 Review details
⏰ Context from checks skipped due to timeout. (12)
- GitHub Check: Pre-commit
- GitHub Check: Test (x86_64)
- GitHub Check: Test (Python 3.14, arm64)
- GitHub Check: Test (Python 3.13, x86_64)
- GitHub Check: Test (Python 3.11, arm64)
- GitHub Check: Test (Python 3.14, x86_64)
- GitHub Check: Test (Python 3.13, arm64)
- GitHub Check: Test (Python 3.12, arm64)
- GitHub Check: Test (Python 3.11, x86_64)
- GitHub Check: Build wheels (x86_64)
- GitHub Check: Test (Python 3.12, x86_64)
- GitHub Check: Build wheels (arm64)
🧰 Additional context used
📓 Path-based instructions (12)
**/*.{md,mdx,html}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Changes affecting public behavior, adapters, examples, or workspace structure must update the corresponding documentation; public API changes require updated SDK or API reference documentation.
Files:
docs/about-nemo-fabric/release-notes.mdx
**/*.{md,mdx}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
For docs site changes, run
just docsto regenerate Python and Rust API references and validate Fern configuration.
**/*.{md,mdx}: Prioritize factual accuracy in NeMo Fabric documentation and keep commands, package names, APIs, file paths, repository layout, entry points, support claims, examples, and procedures aligned with current repository behavior.
Update relevant entry-point documentation when public behavior changes, includingREADME.md,docs/index.yml, package or crate READMEs, and adapter or integration READMEs.
Use{/* ... */}delimiters for top-of-file SPDX comments in MDX files, not HTML comment delimiters.
CapitalizeNVIDIAcorrectly and use consistent current repository terminology, product names, APIs, and feature names.
Format commands, code, expressions, file names, paths, and filenames as inline code where appropriate.
Use title case for technical-documentation headings.
Introduce code blocks, tables, and lists with complete lead-in sentences.
Use descriptive link text instead of raw URLs or generic labels such ashere.
Write procedures as short, imperative, parallel, easy-to-scan steps; prefer active voice, present tense, plain English, and concise sentences.
Useafterinstead ofoncewhen expressing temporal sequence, and usecaninstead ofmaywhen describing possibility rather than permission.
Use unambiguous date formats and avoid ordinal dates in body text.
When reviewing documentation, report findings in severity order underMust fix,Should fix, andNice to have, with file paths, line references, explanations, and concrete rewrites or directions.
Files:
docs/about-nemo-fabric/release-notes.mdx
**/*
📄 CodeRabbit inference engine (CONTRIBUTING.md)
**/*: All source files must include the specified SPDX copyright and Apache-2.0 license header using the comment syntax appropriate to the file type.
Release tags must use raw Rust-compatible SemVer without a leadingv, such as0.1.0or0.1.0-rc.1.
**/*: Before implementing, explicitly state assumptions, surface ambiguity and tradeoffs, present multiple interpretations when relevant, and ask for clarification rather than silently deciding or proceeding when requirements are unclear.
Prefer the minimum code needed to solve the requested problem: avoid speculative features, unnecessary abstractions, unrequested flexibility, and handling of impossible scenarios; simplify overcomplicated solutions.
When editing existing code, make surgical changes only: do not modify unrelated code, comments, formatting, or pre-existing dead code; match the existing style, and remove only unused imports, variables, or functions introduced by your changes.
Define verifiable success criteria for each task, such as writing regression tests for bugs and invalid-input tests for validation, then verify the implementation against those criteria. For multi-step work, state a brief plan with a verification check for each step.
**/*: Keep pull request branch scope coherent and reviewable.
Run relevant tests undervalidate-changebefore opening or updating a pull request.
Format changed files with the language-native formatter.
Update documentation and examples for public behavior changes.
Update dependent maintainer or consumer guidance when code changes affect APIs, bindings, commands, paths, packaging guidance, or best practices.
Use Conventional Commit style for pull request titles:<type>: <concise imperative summary>, choosing the type from the actual change surface. Usefixonly for user-facing or runtime product-code bug fixes.
A pull request body must include#### Overview,#### Details,#### Validation,#### Where should the reviewer start?, and `#### Related ...
Files:
docs/about-nemo-fabric/release-notes.mdx
**/*.mdx
📄 CodeRabbit inference engine (CONTRIBUTING.md)
MDX files must use the specified SPDX header in a JSX comment.
In MDX files, use JSX comment delimiters (
{/*and*/}) for top-of-file comments, including SPDX headers; do not use HTML comments.
Files:
docs/about-nemo-fabric/release-notes.mdx
{README.md,docs/**/*.{md,mdx,yml},examples/**/*.{md,mdx,yml}}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Keep package names, repository references, and build commands current in documentation and examples.
Files:
docs/about-nemo-fabric/release-notes.mdx
{docs/**/*.{md,mdx,yml},examples/**/*.{md,mdx,yml}}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Update relevant getting-started, reference, adapter, and example documentation when the corresponding examples or adapters change.
Files:
docs/about-nemo-fabric/release-notes.mdx
docs/**/*.{md,mdx,yml}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Run
just docswhen the documentation site changes.
Files:
docs/about-nemo-fabric/release-notes.mdx
{docs/**/*,.github/workflows/ci_python.yml,.github/workflows/ci_rust.yml,justfile}
📄 CodeRabbit inference engine (.agents/skills/maintain-packaging/SKILL.md)
Use the current install, import, build, test, clean, and documentation commands consistently in documentation, examples, CI workflows, and just recipes.
Files:
docs/about-nemo-fabric/release-notes.mdx
{docs/**/*,.github/workflows/ci_python.yml,.github/workflows/ci_rust.yml}
📄 CodeRabbit inference engine (.agents/skills/maintain-packaging/SKILL.md)
Reflect public packaging changes in release-facing documentation and examples.
Files:
docs/about-nemo-fabric/release-notes.mdx
**/*.{md,mdx,rst}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
**/*.{md,mdx,rst}: For NeMo Fabric documentation, verify technical claims against the current repository, public API, or documented command before reviewing style.
Always spellNVIDIAin all caps; do not useNvidia,nvidia, orNV.
Format commands, code elements, expressions, package names, file names, and paths as inline code.
Use descriptive link text; avoid raw URLs and weak anchors such ashereorread more.
Use title case consistently for technical documentation headings.
Introduce code blocks, lists, tables, and images with complete sentences.
Write procedures as imperative, parallel steps; split long procedures into smaller tasks.
Prefer active voice, present tense, short sentences, contractions, and plain English while preserving necessary technical precision.
Usecanfor possibility and reservemayfor permission.
Useafterfor temporal relationships instead ofonce, and preferrefer tooverseewhen directing readers to another resource.
Avoid culture-specific idioms, unnecessary Latinisms, jokes, and marketing exaggeration in technical documentation.
Spell out months in body text, avoid ordinal dates, and use clear time zones.
Spell out whole numbers from zero through nine unless they are technical values, parameters, versions, or UI values; use numerals for 10 or greater and commas in thousands.
Do not add trademark symbols to learning-oriented documentation unless the source, platform, or legal guidance explicitly requires them.
Do not replace precise technical terms with simpler words when doing so would lose precision.
Do not flag passive voice when the actor is unknown or the action is the important part.
Do not rewrite API names, package names, command flags, or code literals for style.
**/*.{md,mdx,rst}: Use consistent title case for technical-document headings and table headers; avoid quotation marks, ampersands, and exclamation marks in headings, while preserving official product, event, research, and whitepaper title ...
Files:
docs/about-nemo-fabric/release-notes.mdx
docs/**/*
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
For documentation or examples changes, run
just docswhen practical and verify documented commands against the current repository.
Files:
docs/about-nemo-fabric/release-notes.mdx
{docs/**,README.md,AGENTS.md}
⚙️ CodeRabbit configuration file
{docs/**,README.md,AGENTS.md}: Review documentation for technical accuracy against the current API, command correctness, and consistency with generated schemas.
Files:
docs/about-nemo-fabric/release-notes.mdx
🔇 Additional comments (1)
docs/about-nemo-fabric/release-notes.mdx (1)
28-30: LGTM!
- Add an introductory sentence before the Choose Your Interface table - Align the Core Workflow diagram to use "Hermes Agent" and "Codex", matching the overview intro Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Signed-off-by: Linette Tang <lvojktu@nvidia.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Signed-off-by: Linette Tang <lvojktu@nvidia.com>
There was a problem hiding this comment.
Not sure where this document came from, we don't need a quickstart and a quick-start
2 participants
Overview
Aligns the About-area documentation with the NVIDIA tech-docs template library and cleans up Getting Started navigation. Docs-only change; no product/runtime code, public API, or packaging is affected.
Changes:
docs/about-nemo-fabric/overview.mdx): headings converted to title case and the page restructured to follow the tech-docs About/overview template — intro,Benefits,Use Cases,Core Workflow, andLearn More.docs/getting-started/quick-start.mdx).docs/index.yml):Install→Installation,Quickstart→Beginner Tutorial, and a newQuickstartpage. Slugs are pinned (install,quickstart,quick-start) so existing published URLs remain stable and no redirects are needed.docs/about-nemo-fabric/release-notes.mdx): scaffolded from the tech-docs release-notes template with placeholders (Highlights, Support Matrix and Compatibility Updates, Fixed Known Issues, All Known Issues, Previous Versions, Related Topics). The NIM-specific Production Branch note was omitted; angle-bracket placeholders are wrapped in backticks so MDX parses cleanly.Validation:
fern checkpasses (0 errors, 0 warnings). The Python API references were regenerated (no diff). The Rust library reference regeneration was not run —cargois not available in this environment.Where should the reviewer start?
Start with
docs/about-nemo-fabric/overview.mdxto review the template restructure and title-case headings, thendocs/index.ymlfor the nav renames and pinned slugs (the key decision that keeps published URLs stable).docs/about-nemo-fabric/release-notes.mdxis a placeholder scaffold to be filled at release time.Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)
Summary by CodeRabbit