Skip to content

docs: prepare consumer skill for NVCARPS - #182

Merged
exactlyallan merged 3 commits into
NVIDIA:mainfrom
exactlyallan:docs/nvcarps-skill-onboarding
Aug 7, 2026
Merged

docs: prepare consumer skill for NVCARPS#182
exactlyallan merged 3 commits into
NVIDIA:mainfrom
exactlyallan:docs/nvcarps-skill-onboarding

Conversation

@exactlyallan

@exactlyallan exactlyallan commented Aug 6, 2026

Copy link
Copy Markdown
Collaborator

Overview

Prepare the public nemo-fabric-integrate consumer skill for NVSkills and
NVCARPS onboarding. The bundle now uses the canonical skills/<skill-name>/
release path and includes the small positive and negative evaluation dataset
required as source input for the validation pipeline.

This changes the repository path used when copying the consumer skill from a
source checkout. It does not change the NeMo Fabric Python SDK or runtime.
NVCARPS-generated benchmarks, skill cards, and signatures are intentionally not
authored in this pull request; /nvskills-ci will produce them from the source
bundle and evals.

Details

  • Move nemo-fabric-integrate from
    skills/integrations/consumer/nemo-fabric-integrate/ to
    skills/nemo-fabric-integrate/.
  • Add two positive integration cases and two negative routing cases in
    evals/evals.json.
  • Keep the exported bundle portable and aligned with NVIDIA documentation style
    by removing repository-internal maintainer guidance and correcting product
    naming, possibility wording, and cross-references.
  • Update AGENTS.md and skills/README.md for the canonical consumer-skill
    layout.
  • Preserve .agents/skills/ and .claude/skills as maintainer-only discovery
    surfaces.

Validation

  • Codex skill quick validator for skills/nemo-fabric-integrate (Skill is valid!)
  • Eval JSON structure, unique IDs, and two-positive/two-negative coverage check
  • uv run --extra codex --group test pytest tests/adapters/test_codex_adapter.py -k test_codex_config_resolves_sdk_adapter -q (1 passed, 43 deselected)
  • git diff --check
  • just docs not run because no Fern docs or generated API references changed
  • NVCARPS validation pending /nvskills-ci

Where should the reviewer start?

Start with skills/nemo-fabric-integrate/evals/evals.json for the expected
trigger boundaries, then review skills/README.md and AGENTS.md for the
consumer-versus-maintainer directory contract.

Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)

  • Relates to: none

  • I confirm this contribution is my own work, or I have the right to submit it under this project's license.

  • I searched existing issues and open pull requests, and this does not duplicate existing work.

Summary by CodeRabbit

  • New Features

    • Added integration evaluation scenarios covering Python services, repeated invocation workflows, and incorrect usage patterns.
  • Documentation

    • Updated skill navigation and project-copy instructions to reflect the standalone integration skill location.
    • Clarified configuration ownership, result and error handling, correlation IDs, transient failures, runtime behavior, and reference guidance.
    • Refined NeMo Fabric integration documentation and links for clearer, more accurate guidance.

Move the public consumer skill bundle to the canonical skills/<name> path required by NVSkills publication and add focused positive and negative routing evaluations.

Update repository guidance for the flat consumer-skill layout while preserving .agents/skills and .claude/skills as maintainer-only discovery surfaces.

Validation: skill quick validator; eval schema checks; focused Codex adapter path test; git diff --check.
Signed-off-by: Allan Enemark <exactly.allan@gmail.com>
@coderabbitai

coderabbitai Bot commented Aug 6, 2026

Copy link
Copy Markdown

Review Change Stack

Walkthrough

The PR moves consumer skill documentation to a standalone skills/ path. It updates integration guidance and reference wording, and adds four evaluation scenarios for routing and NeMo Fabric integration behavior.

Changes

NeMo Fabric integration skill

Layer / File(s) Summary
Standalone skill placement
AGENTS.md, skills/README.md
Repository guidance places consumer skills directly under skills/. Maintainer adapter work remains under .agents/skills/.
Integration skill guidance and evaluation
skills/nemo-fabric-integrate/SKILL.md, skills/nemo-fabric-integrate/evals/evals.json
The skill guidance and references are updated. Evaluation cases cover public SDK integration, lifecycle and configuration handling, credentials, and routing exclusions.
SDK and result reference wording
skills/nemo-fabric-integrate/references/*
References clarify configuration ownership, execution terminology, result errors, correlation IDs, and retryable metadata.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

  • NVIDIA/NeMo-Fabric#176: Both PRs update NeMo Fabric integration skill documentation and configuration guidance.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title follows Conventional Commits format, uses an allowed type, stays under 72 characters, and summarizes the documentation changes.
Description check ✅ Passed The description includes all required template sections, explains the changes, identifies review starting points, records validation, and includes both confirmations.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

@exactlyallan exactlyallan self-assigned this Aug 6, 2026
@exactlyallan exactlyallan added the enhancement New feature or request label Aug 6, 2026
@exactlyallan
exactlyallan marked this pull request as ready for review August 6, 2026 18:07
@exactlyallan
exactlyallan requested a review from a team as a code owner August 6, 2026 18:07

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 5

🤖 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 `@skills/nemo-fabric-integrate/references/results-and-errors.md`:
- Around line 45-47: Update the cross-reference in the results-and-errors
documentation paragraph to replace “See the [errors reference]” with “Refer to
the [errors reference]”, leaving the surrounding error behavior description
unchanged.
- Around line 16-18: Update the documentation statements associated with the
result `error` field and transient failure metadata to use “can” instead of
“may” when describing possible presence or absence. Preserve the existing
meaning and surrounding guidance.

In `@skills/nemo-fabric-integrate/SKILL.md`:
- Around line 2-3: Use the full product name at the first user-facing mention,
then use the abbreviation consistently: update
skills/nemo-fabric-integrate/SKILL.md lines 2-3 (frontmatter description) and
line 9 (H1), skills/nemo-fabric-integrate/references/config-mapping.md lines
8-10, skills/nemo-fabric-integrate/references/sdk-api-inventory.md lines 56-59,
and skills/nemo-fabric-integrate/references/results-and-errors.md lines 34-40 to
begin with “NVIDIA NeMo Fabric” and use “NeMo Fabric” thereafter.
- Around line 17-19: Remove the repository-internal maintainer guidance
paragraph from the exported skill content near the NeMo Fabric usage
restrictions, including the reference to `.agents/skills/`. Preserve the
remaining consumer-facing scope and restrictions, leaving maintainer guidance to
`AGENTS.md` and `skills/README.md`.

In `@skills/README.md`:
- Around line 59-60: Update the Markdown table header in the skills README so
“Use it when” uses title case: “Use It When”.
🪄 Autofix

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: b41a8482-697b-4e34-914f-74af128c9795

📥 Commits

Reviewing files that changed from the base of the PR and between 7a3272d and 0957c43.

📒 Files selected for processing (7)
  • AGENTS.md
  • skills/README.md
  • skills/nemo-fabric-integrate/SKILL.md
  • skills/nemo-fabric-integrate/evals/evals.json
  • skills/nemo-fabric-integrate/references/config-mapping.md
  • skills/nemo-fabric-integrate/references/results-and-errors.md
  • skills/nemo-fabric-integrate/references/sdk-api-inventory.md
📜 Review details
🧰 Additional context used
📓 Path-based instructions (17)
**/*.{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:

  • skills/nemo-fabric-integrate/evals/evals.json
**/*

📄 CodeRabbit inference engine (.agents/skills/karpathy-guidelines/SKILL.md)

**/*: 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.

**/*: Always spell NVIDIA in all caps; do not use Nvidia, nvidia, nVidia, nVIDIA, or NV.
Use an NVIDIA before a noun, because the name begins with an “en” sound.
Do not add a registered trademark symbol after NVIDIA when referring to the company; use trademark symbols with product names only when required by the document type or legal guidance.
Verify official capitalization, spacing, hyphenation, and spelling for NVIDIA and third-party product names; do not rewrite official product names for grammar or title-case rules.
Precede NVIDIA product names with NVIDIA on first mention when natural and accurate, and link the first mention when the destination helps the reader.
On first use, include the company name and full model qualifier when it helps identify the model; preserve official capitalization and punctuation, and use shorter family names only after establishing the full name.
For learning-oriented and developer content, do not force trademark symbols unless explicitly required; for press, ...

Files:

  • skills/nemo-fabric-integrate/evals/evals.json
  • AGENTS.md
  • skills/README.md
  • skills/nemo-fabric-integrate/references/results-and-errors.md
  • skills/nemo-fabric-integrate/references/config-mapping.md
  • skills/nemo-fabric-integrate/references/sdk-api-inventory.md
  • skills/nemo-fabric-integrate/SKILL.md
**/*.{json,jsonschema}

📄 CodeRabbit inference engine (CONTRIBUTING.md)

Public contract changes must keep checked-in JSON Schema snapshots synchronized.

Files:

  • skills/nemo-fabric-integrate/evals/evals.json
skills/**

📄 CodeRabbit inference engine (AGENTS.md)

skills/**: Keep consumer integration skills under skills/; they must depend only on supported public Python SDK contracts and published documentation, not repository internals.
Do not add repository-internal contribution guidance to consumer skills.
Consumer skills must link to public GitHub documentation and example URLs rather than a docs-site domain so they remain portable when exported.

Files:

  • skills/nemo-fabric-integrate/evals/evals.json
  • skills/README.md
  • skills/nemo-fabric-integrate/references/results-and-errors.md
  • skills/nemo-fabric-integrate/references/config-mapping.md
  • skills/nemo-fabric-integrate/references/sdk-api-inventory.md
  • skills/nemo-fabric-integrate/SKILL.md
skills/nemo-fabric-integrate/**

📄 CodeRabbit inference engine (AGENTS.md)

The consumer integration skill provides typed Python SDK integration guidance; consumer skills must be independently exportable, validated, and publishable.

Files:

  • skills/nemo-fabric-integrate/evals/evals.json
  • skills/nemo-fabric-integrate/references/results-and-errors.md
  • skills/nemo-fabric-integrate/references/config-mapping.md
  • skills/nemo-fabric-integrate/references/sdk-api-inventory.md
  • skills/nemo-fabric-integrate/SKILL.md
{docs/sdk/python.mdx,schemas/SCHEMA.md,docs/reference/api/**,skills/**}

📄 CodeRabbit inference engine (AGENTS.md)

When the public API changes, keep the Python/Rust binding contract current in the Python SDK docs, schema notes, generated API references, and consumer skills; regenerate documentation with just docs.

Files:

  • skills/nemo-fabric-integrate/evals/evals.json
  • skills/README.md
  • skills/nemo-fabric-integrate/references/results-and-errors.md
  • skills/nemo-fabric-integrate/references/config-mapping.md
  • skills/nemo-fabric-integrate/references/sdk-api-inventory.md
  • skills/nemo-fabric-integrate/SKILL.md
**/*.{md,rst}

📄 CodeRabbit inference engine (.agents/skills/contribute-api/SKILL.md)

Update documentation and examples in the same branch as the public API change.

Files:

  • AGENTS.md
  • skills/README.md
  • skills/nemo-fabric-integrate/references/results-and-errors.md
  • skills/nemo-fabric-integrate/references/config-mapping.md
  • skills/nemo-fabric-integrate/references/sdk-api-inventory.md
  • skills/nemo-fabric-integrate/SKILL.md
**/*.{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 spell NVIDIA in all caps; do not use Nvidia, nvidia, or NV.
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 as here or read 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.
Use can for possibility and reserve may for permission.
Use after for temporal relationships instead of once, and prefer refer to over see when 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:

  • AGENTS.md
  • skills/README.md
  • skills/nemo-fabric-integrate/references/results-and-errors.md
  • skills/nemo-fabric-integrate/references/config-mapping.md
  • skills/nemo-fabric-integrate/references/sdk-api-inventory.md
  • skills/nemo-fabric-integrate/SKILL.md
**/*.{md,rst,txt,adoc}

📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-language-mechanics.md)

**/*.{md,rst,txt,adoc}: For technical documentation, use professional, active, conversational, engaging, precise, and plain-English prose. Prefer active voice, present tense, short sentences, and scannable paragraphs. Avoid casual or imprecise language, swearing, threats, insults, jokes, puns, culture-specific idioms, marketing exaggeration, and unsupported third-party comparisons.
Use can for possibility and reserve may for permission; use after for temporal order; use refer to for cross-references; prefer short direct sentences and specific verbs; avoid unnecessary please in technical documentation.
Prefer active voice when the actor matters. Passive voice is acceptable when the actor is unknown or irrelevant, when the action or result is the focus, or in programmer documentation.
Use natural contractions in conversational technical prose, but do not force them in formal legal copy, API references, or generated text.
Prefer simpler English over Latinisms: use for example or such as instead of e.g., and so on instead of etc., that is instead of i.e., compared to instead of vs., and by, through, or using instead of via. Use industry-standard terms such as in silico, in vitro, and in vivo when appropriate, and italicize them in running text.
Use that without commas for essential clauses, and which with commas for nonessential clauses.
Format dates and times clearly: spell out months in body text; use forms such as June 12, 2025; avoid numeric or ordinal dates; capitalize days; use 12-hour time when appropriate; include a space before a.m. or p.m.; use ET and PT for needed time zones; avoid 24/7; and prefer from 12:30 to 1:00 p.m. for prose ranges.
Format numbers consistently: spell out zero through nine in body text, use numerals for 10 or greater and for technical values, use commas in thousands, do not begin a sentence with a numeral, spell out ordinals, and use numerals consistently within a category wh...

Files:

  • AGENTS.md
  • skills/README.md
  • skills/nemo-fabric-integrate/references/results-and-errors.md
  • skills/nemo-fabric-integrate/references/config-mapping.md
  • skills/nemo-fabric-integrate/references/sdk-api-inventory.md
  • skills/nemo-fabric-integrate/SKILL.md
**/AGENTS.md

📄 CodeRabbit inference engine (CLAUDE.md)

Follow the instructions documented in AGENTS.md when working in the repository.

Files:

  • AGENTS.md
**/*.{md,mdx,yml,py,rs,sh}

📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)

Keep documentation aligned with current NeMo Fabric behavior, repository layout, entry points, commands, package names, APIs, bindings, and support claims.

Files:

  • AGENTS.md
  • skills/README.md
  • skills/nemo-fabric-integrate/references/results-and-errors.md
  • skills/nemo-fabric-integrate/references/config-mapping.md
  • skills/nemo-fabric-integrate/references/sdk-api-inventory.md
  • skills/nemo-fabric-integrate/SKILL.md
**/*.{md,mdx}

📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)

**/*.{md,mdx}: Use the full product name NVIDIA NeMo Fabric on first use, typically in the title and H1; use NeMo Fabric thereafter. Use fabric alone only for the CLI tool and surround it with backticks.
Treat incorrect or stale commands, package names, paths, APIs, support claims, procedures, examples, terminology, or public behavior documentation as blocking issues.
Capitalize NVIDIA correctly and format code, commands, paths, and filenames as inline code where needed.
Use title case for technical-documentation headings.
Introduce code blocks, tables, and lists with complete lead-in sentences; ensure examples match current APIs and build commands.
Use descriptive anchor text, avoid raw URLs and generic labels such as here, and use repository-relative .mdx paths for links within docs/.
Prefer active voice, present tense, short sentences, plain English, consistent terminology, and imperative, parallel, scannable procedures.
Use after instead of once when expressing temporal sequence, and use can rather than may when describing possibility rather than permission.
Avoid ambiguous numeric dates and ordinal dates in body text.
For learning-oriented documentation, do not force trademark symbols unless the source document explicitly requires them.
When reporting documentation-review findings, lead with Must fix, Should fix, and Nice to have categories; include file path, line reference, current problem, rationale, and a concrete rewrite or direction.

Files:

  • AGENTS.md
  • skills/README.md
  • skills/nemo-fabric-integrate/references/results-and-errors.md
  • skills/nemo-fabric-integrate/references/config-mapping.md
  • skills/nemo-fabric-integrate/references/sdk-api-inventory.md
  • skills/nemo-fabric-integrate/SKILL.md
**/*.md

📄 CodeRabbit inference engine (CONTRIBUTING.md)

Update relevant SDK, API reference, adapter, example, integration, and support documentation when the corresponding public surface changes.

Files:

  • AGENTS.md
  • skills/README.md
  • skills/nemo-fabric-integrate/references/results-and-errors.md
  • skills/nemo-fabric-integrate/references/config-mapping.md
  • skills/nemo-fabric-integrate/references/sdk-api-inventory.md
  • skills/nemo-fabric-integrate/SKILL.md
**/*.{html,md}

📄 CodeRabbit inference engine (CONTRIBUTING.md)

HTML and Markdown files must use the specified SPDX HTML-comment header.

Files:

  • AGENTS.md
  • skills/README.md
  • skills/nemo-fabric-integrate/references/results-and-errors.md
  • skills/nemo-fabric-integrate/references/config-mapping.md
  • skills/nemo-fabric-integrate/references/sdk-api-inventory.md
  • skills/nemo-fabric-integrate/SKILL.md
{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.
For links between files under docs/, require paths relative to the source file with the target file's .mdx extension so they work in both Fern builds and repository browsers. Flag Fern site-root links such as NeMo Fabric overview; use the repository-relative equivalent, such as NeMo Fabric overview.

Files:

  • AGENTS.md
{*.md,**/*.md,**/*.mdx,**/*.ipynb}

⚙️ CodeRabbit configuration file

{*.md,**/*.md,**/*.mdx,**/*.ipynb}: Enforce the product name in user-facing prose: use "NVIDIA NeMo Fabric" on first use and "NeMo Fabric" thereafter. Flag standalone capitalized "Fabric" when it refers to the product. Do not flag the lowercase fabric CLI command, package/import/crate names, code identifiers, API symbols, configuration keys, file paths, or unrelated generic uses of the word.

Files:

  • AGENTS.md
  • skills/README.md
  • skills/nemo-fabric-integrate/references/results-and-errors.md
  • skills/nemo-fabric-integrate/references/config-mapping.md
  • skills/nemo-fabric-integrate/references/sdk-api-inventory.md
  • skills/nemo-fabric-integrate/SKILL.md
**/SKILL.md

📄 CodeRabbit inference engine (.agents/skills/README.md)

Each maintainer skill file must begin with YAML frontmatter containing at least name and description.

Files:

  • skills/nemo-fabric-integrate/SKILL.md

⚙️ CodeRabbit configuration file

**/SKILL.md: Do not flag SKILL.md files for missing SPDX headers. Skill entrypoints intentionally start with YAML frontmatter instead.
Verify that every SKILL.md keeps valid YAML frontmatter with at least name and description fields before the Markdown body.

Files:

  • skills/nemo-fabric-integrate/SKILL.md
🧠 Learnings (1)
📓 Common learnings
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric

Timestamp: 2026-08-06T17:59:25.828Z
Learning: Use branch prefixes `feat/`, `fix/`, `docs/`, `test/`, or `refactor/`. Name branches after the work and never include Linear ticket IDs or slugs.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric

Timestamp: 2026-08-06T17:59:25.828Z
Learning: Use signed-off commits for pull-request work with `git commit -s`.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric

Timestamp: 2026-08-06T17:59:25.828Z
Learning: When creating a pull request from the current branch, target the upstream repository rather than a fork.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric

Timestamp: 2026-08-06T17:59:25.828Z
Learning: If repository-local PR guidance conflicts with generic GitHub connector or plugin guidance, follow the repository-local guidance for PR body format and review handoff details.
🔇 Additional comments (8)
AGENTS.md (1)

39-42: LGTM!

skills/README.md (1)

38-41: LGTM!

Also applies to: 55-58, 61-68

skills/nemo-fabric-integrate/SKILL.md (1)

1-1: LGTM!

Also applies to: 4-7, 11-16, 21-374

skills/nemo-fabric-integrate/evals/evals.json (2)

2-58: LGTM!


1-1: 📐 Maintainability & Code Quality

No SPDX header is required for evals.json. The repository excludes .json files from its copyright check, and tracked JSON files remain strict JSON.

			> Likely an incorrect or invalid review comment.
skills/nemo-fabric-integrate/references/config-mapping.md (1)

1-7: LGTM!

Also applies to: 12-148

skills/nemo-fabric-integrate/references/sdk-api-inventory.md (1)

1-16: LGTM!

Also applies to: 18-54, 60-79

skills/nemo-fabric-integrate/references/results-and-errors.md (1)

1-15: LGTM!

Also applies to: 19-33, 41-44, 48-66, 70-71

Comment thread skills/README.md Outdated

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Caution

Inline review comments failed to post. This is likely due to GitHub's internal server error or limits when posting large numbers of comments. If you are seeing this consistently it is likely a permissions issue. Please check "Moderation" -> "Code review limits" under your organization settings.

Actionable comments posted: 5

🤖 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 `@skills/nemo-fabric-integrate/references/results-and-errors.md`:
- Around line 45-47: Update the cross-reference in the results-and-errors
documentation paragraph to replace “See the [errors reference]” with “Refer to
the [errors reference]”, leaving the surrounding error behavior description
unchanged.
- Around line 16-18: Update the documentation statements associated with the
result `error` field and transient failure metadata to use “can” instead of
“may” when describing possible presence or absence. Preserve the existing
meaning and surrounding guidance.

In `@skills/nemo-fabric-integrate/SKILL.md`:
- Around line 2-3: Use the full product name at the first user-facing mention,
then use the abbreviation consistently: update
skills/nemo-fabric-integrate/SKILL.md lines 2-3 (frontmatter description) and
line 9 (H1), skills/nemo-fabric-integrate/references/config-mapping.md lines
8-10, skills/nemo-fabric-integrate/references/sdk-api-inventory.md lines 56-59,
and skills/nemo-fabric-integrate/references/results-and-errors.md lines 34-40 to
begin with “NVIDIA NeMo Fabric” and use “NeMo Fabric” thereafter.
- Around line 17-19: Remove the repository-internal maintainer guidance
paragraph from the exported skill content near the NeMo Fabric usage
restrictions, including the reference to `.agents/skills/`. Preserve the
remaining consumer-facing scope and restrictions, leaving maintainer guidance to
`AGENTS.md` and `skills/README.md`.

In `@skills/README.md`:
- Around line 59-60: Update the Markdown table header in the skills README so
“Use it when” uses title case: “Use It When”.
🪄 Autofix

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: b41a8482-697b-4e34-914f-74af128c9795

📥 Commits

Reviewing files that changed from the base of the PR and between 7a3272d and 0957c43.

📒 Files selected for processing (7)
  • AGENTS.md
  • skills/README.md
  • skills/nemo-fabric-integrate/SKILL.md
  • skills/nemo-fabric-integrate/evals/evals.json
  • skills/nemo-fabric-integrate/references/config-mapping.md
  • skills/nemo-fabric-integrate/references/results-and-errors.md
  • skills/nemo-fabric-integrate/references/sdk-api-inventory.md
📜 Review details
🔇 Additional comments (8)
AGENTS.md (1)

39-42: LGTM!

skills/README.md (1)

38-41: LGTM!

Also applies to: 55-58, 61-68

skills/nemo-fabric-integrate/SKILL.md (1)

1-1: LGTM!

Also applies to: 4-7, 11-16, 21-374

skills/nemo-fabric-integrate/evals/evals.json (2)

2-58: LGTM!


1-1: 📐 Maintainability & Code Quality

No SPDX header is required for evals.json. The repository excludes .json files from its copyright check, and tracked JSON files remain strict JSON.

			> Likely an incorrect or invalid review comment.
skills/nemo-fabric-integrate/references/config-mapping.md (1)

1-7: LGTM!

Also applies to: 12-148

skills/nemo-fabric-integrate/references/sdk-api-inventory.md (1)

1-16: LGTM!

Also applies to: 18-54, 60-79

skills/nemo-fabric-integrate/references/results-and-errors.md (1)

1-15: LGTM!

Also applies to: 19-33, 41-44, 48-66, 70-71

🛑 Comments failed to post (4)
skills/nemo-fabric-integrate/references/results-and-errors.md (2)

16-18: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Should fix: use can for possibility.

In skills/nemo-fabric-integrate/references/results-and-errors.md, Line 17 says error “may be None,” and Line 67 says transient failures “may carry” metadata. Both statements express possibility. Replace may with can.

As per coding guidelines, use can for possibility and reserve may for permission.

Also applies to: 67-69

🤖 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 `@skills/nemo-fabric-integrate/references/results-and-errors.md` around lines
16 - 18, Update the documentation statements associated with the result `error`
field and transient failure metadata to use “can” instead of “may” when
describing possible presence or absence. Preserve the existing meaning and
surrounding guidance.

Source: Coding guidelines


45-47: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Should fix: use Refer to for cross-references.

In skills/nemo-fabric-integrate/references/results-and-errors.md, Line 47 says See the [errors reference]. Replace it with Refer to the [errors reference].

As per coding guidelines, use refer to instead of see when directing readers to another resource.

🤖 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 `@skills/nemo-fabric-integrate/references/results-and-errors.md` around lines
45 - 47, Update the cross-reference in the results-and-errors documentation
paragraph to replace “See the [errors reference]” with “Refer to the [errors
reference]”, leaving the surrounding error behavior description unchanged.

Source: Coding guidelines

skills/nemo-fabric-integrate/SKILL.md (2)

2-3: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Should fix: use the full product name consistently across the exportable documents.

The first product mention is abbreviated in each affected document. Use NVIDIA NeMo Fabric at the first user-facing mention, then use NeMo Fabric.

  • skills/nemo-fabric-integrate/SKILL.md#L2-L3: update the frontmatter description.
  • skills/nemo-fabric-integrate/SKILL.md#L9-L9: update the H1.
  • skills/nemo-fabric-integrate/references/config-mapping.md#L8-L10: update the first prose mention.
  • skills/nemo-fabric-integrate/references/sdk-api-inventory.md#L56-L59: update the first prose mention.
  • skills/nemo-fabric-integrate/references/results-and-errors.md#L34-L40: update the first prose mention.

As per path instructions, user-facing Markdown must use NVIDIA NeMo Fabric on first use and NeMo Fabric thereafter.

📍 Affects 4 files
  • skills/nemo-fabric-integrate/SKILL.md#L2-L3 (this comment)
  • skills/nemo-fabric-integrate/SKILL.md#L9-L9
  • skills/nemo-fabric-integrate/references/config-mapping.md#L8-L10
  • skills/nemo-fabric-integrate/references/sdk-api-inventory.md#L56-L59
  • skills/nemo-fabric-integrate/references/results-and-errors.md#L34-L40
🤖 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 `@skills/nemo-fabric-integrate/SKILL.md` around lines 2 - 3, Use the full
product name at the first user-facing mention, then use the abbreviation
consistently: update skills/nemo-fabric-integrate/SKILL.md lines 2-3
(frontmatter description) and line 9 (H1),
skills/nemo-fabric-integrate/references/config-mapping.md lines 8-10,
skills/nemo-fabric-integrate/references/sdk-api-inventory.md lines 56-59, and
skills/nemo-fabric-integrate/references/results-and-errors.md lines 34-40 to
begin with “NVIDIA NeMo Fabric” and use “NeMo Fabric” thereafter.

Source: Path instructions


17-19: 📐 Maintainability & Code Quality | 🟠 Major | ⚡ Quick win

Must fix: remove repository-internal maintainer guidance from this exportable skill.

In skills/nemo-fabric-integrate/SKILL.md, Lines 17-19 direct users to .agents/skills/. That path is repository-internal and is not portable when the skill is copied into another project. Remove this paragraph. Keep maintainer guidance in AGENTS.md and skills/README.md.

Proposed surgical change
-Do not use this skill to author or modify NeMo Fabric adapters, change NeMo Fabric core or
-its bindings, or maintain repository infrastructure. If you are contributing to
-NeMo Fabric itself, use the maintainer skills in `.agents/skills/` instead.

As per coding guidelines, consumer skills must depend only on supported public Python SDK contracts and published documentation, not repository internals, and must not contain repository-internal contribution guidance.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.


🤖 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 `@skills/nemo-fabric-integrate/SKILL.md` around lines 17 - 19, Remove the
repository-internal maintainer guidance paragraph from the exported skill
content near the NeMo Fabric usage restrictions, including the reference to
`.agents/skills/`. Preserve the remaining consumer-facing scope and
restrictions, leaving maintainer guidance to `AGENTS.md` and `skills/README.md`.

Source: Coding guidelines

Remove the repository-internal maintainer path from the exportable skill, use the full NVIDIA NeMo Fabric name on first mention, and align possibility and cross-reference wording with the documentation style guide.

Validation: skill quick validator; review-specific terminology and portability assertions; eval schema checks; focused Codex adapter path test; git diff --check.
Signed-off-by: Allan Enemark <exactly.allan@gmail.com>

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 `@skills/nemo-fabric-integrate/references/results-and-errors.md`:
- Line 17: The result contract documentation incorrectly claims non-success
results may have error set to None. In
skills/nemo-fabric-integrate/references/results-and-errors.md:17 and
skills/nemo-fabric-integrate/SKILL.md:295, remove this claim from both
documents, unless a contract test is added and the implementation is updated to
produce a non-success result with error == None.
🪄 Autofix

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: 0466f846-b337-4b92-a202-5474927a21b5

📥 Commits

Reviewing files that changed from the base of the PR and between 0957c43 and 3b51a31.

📒 Files selected for processing (4)
  • skills/nemo-fabric-integrate/SKILL.md
  • skills/nemo-fabric-integrate/references/config-mapping.md
  • skills/nemo-fabric-integrate/references/results-and-errors.md
  • skills/nemo-fabric-integrate/references/sdk-api-inventory.md
📜 Review details
🧰 Additional context used
📓 Path-based instructions (14)
**/*.{md,rst}

📄 CodeRabbit inference engine (.agents/skills/contribute-api/SKILL.md)

Update documentation and examples in the same branch as the public API change.

Files:

  • skills/nemo-fabric-integrate/references/sdk-api-inventory.md
  • skills/nemo-fabric-integrate/references/results-and-errors.md
  • skills/nemo-fabric-integrate/references/config-mapping.md
  • skills/nemo-fabric-integrate/SKILL.md
**/*

📄 CodeRabbit inference engine (.agents/skills/karpathy-guidelines/SKILL.md)

**/*: 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.

**/*: Always spell NVIDIA in all caps; do not use Nvidia, nvidia, nVidia, nVIDIA, or NV.
Use an NVIDIA before a noun, because the name begins with an “en” sound.
Do not add a registered trademark symbol after NVIDIA when referring to the company; use trademark symbols with product names only when required by the document type or legal guidance.
Verify official capitalization, spacing, hyphenation, and spelling for NVIDIA and third-party product names; do not rewrite official product names for grammar or title-case rules.
Precede NVIDIA product names with NVIDIA on first mention when natural and accurate, and link the first mention when the destination helps the reader.
On first use, include the company name and full model qualifier when it helps identify the model; preserve official capitalization and punctuation, and use shorter family names only after establishing the full name.
For learning-oriented and developer content, do not force trademark symbols unless explicitly required; for press, ...

Files:

  • skills/nemo-fabric-integrate/references/sdk-api-inventory.md
  • skills/nemo-fabric-integrate/references/results-and-errors.md
  • skills/nemo-fabric-integrate/references/config-mapping.md
  • skills/nemo-fabric-integrate/SKILL.md
**/*.{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 spell NVIDIA in all caps; do not use Nvidia, nvidia, or NV.
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 as here or read 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.
Use can for possibility and reserve may for permission.
Use after for temporal relationships instead of once, and prefer refer to over see when 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:

  • skills/nemo-fabric-integrate/references/sdk-api-inventory.md
  • skills/nemo-fabric-integrate/references/results-and-errors.md
  • skills/nemo-fabric-integrate/references/config-mapping.md
  • skills/nemo-fabric-integrate/SKILL.md
**/*.{md,rst,txt,adoc}

📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-language-mechanics.md)

**/*.{md,rst,txt,adoc}: For technical documentation, use professional, active, conversational, engaging, precise, and plain-English prose. Prefer active voice, present tense, short sentences, and scannable paragraphs. Avoid casual or imprecise language, swearing, threats, insults, jokes, puns, culture-specific idioms, marketing exaggeration, and unsupported third-party comparisons.
Use can for possibility and reserve may for permission; use after for temporal order; use refer to for cross-references; prefer short direct sentences and specific verbs; avoid unnecessary please in technical documentation.
Prefer active voice when the actor matters. Passive voice is acceptable when the actor is unknown or irrelevant, when the action or result is the focus, or in programmer documentation.
Use natural contractions in conversational technical prose, but do not force them in formal legal copy, API references, or generated text.
Prefer simpler English over Latinisms: use for example or such as instead of e.g., and so on instead of etc., that is instead of i.e., compared to instead of vs., and by, through, or using instead of via. Use industry-standard terms such as in silico, in vitro, and in vivo when appropriate, and italicize them in running text.
Use that without commas for essential clauses, and which with commas for nonessential clauses.
Format dates and times clearly: spell out months in body text; use forms such as June 12, 2025; avoid numeric or ordinal dates; capitalize days; use 12-hour time when appropriate; include a space before a.m. or p.m.; use ET and PT for needed time zones; avoid 24/7; and prefer from 12:30 to 1:00 p.m. for prose ranges.
Format numbers consistently: spell out zero through nine in body text, use numerals for 10 or greater and for technical values, use commas in thousands, do not begin a sentence with a numeral, spell out ordinals, and use numerals consistently within a category wh...

Files:

  • skills/nemo-fabric-integrate/references/sdk-api-inventory.md
  • skills/nemo-fabric-integrate/references/results-and-errors.md
  • skills/nemo-fabric-integrate/references/config-mapping.md
  • skills/nemo-fabric-integrate/SKILL.md
**/*.{md,mdx,yml,py,rs,sh}

📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)

Keep documentation aligned with current NeMo Fabric behavior, repository layout, entry points, commands, package names, APIs, bindings, and support claims.

Files:

  • skills/nemo-fabric-integrate/references/sdk-api-inventory.md
  • skills/nemo-fabric-integrate/references/results-and-errors.md
  • skills/nemo-fabric-integrate/references/config-mapping.md
  • skills/nemo-fabric-integrate/SKILL.md
**/*.{md,mdx}

📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)

**/*.{md,mdx}: Use the full product name NVIDIA NeMo Fabric on first use, typically in the title and H1; use NeMo Fabric thereafter. Use fabric alone only for the CLI tool and surround it with backticks.
Treat incorrect or stale commands, package names, paths, APIs, support claims, procedures, examples, terminology, or public behavior documentation as blocking issues.
Capitalize NVIDIA correctly and format code, commands, paths, and filenames as inline code where needed.
Use title case for technical-documentation headings.
Introduce code blocks, tables, and lists with complete lead-in sentences; ensure examples match current APIs and build commands.
Use descriptive anchor text, avoid raw URLs and generic labels such as here, and use repository-relative .mdx paths for links within docs/.
Prefer active voice, present tense, short sentences, plain English, consistent terminology, and imperative, parallel, scannable procedures.
Use after instead of once when expressing temporal sequence, and use can rather than may when describing possibility rather than permission.
Avoid ambiguous numeric dates and ordinal dates in body text.
For learning-oriented documentation, do not force trademark symbols unless the source document explicitly requires them.
When reporting documentation-review findings, lead with Must fix, Should fix, and Nice to have categories; include file path, line reference, current problem, rationale, and a concrete rewrite or direction.

Files:

  • skills/nemo-fabric-integrate/references/sdk-api-inventory.md
  • skills/nemo-fabric-integrate/references/results-and-errors.md
  • skills/nemo-fabric-integrate/references/config-mapping.md
  • skills/nemo-fabric-integrate/SKILL.md
**/*.md

📄 CodeRabbit inference engine (CONTRIBUTING.md)

Update relevant SDK, API reference, adapter, example, integration, and support documentation when the corresponding public surface changes.

Files:

  • skills/nemo-fabric-integrate/references/sdk-api-inventory.md
  • skills/nemo-fabric-integrate/references/results-and-errors.md
  • skills/nemo-fabric-integrate/references/config-mapping.md
  • skills/nemo-fabric-integrate/SKILL.md
**/*.{html,md}

📄 CodeRabbit inference engine (CONTRIBUTING.md)

HTML and Markdown files must use the specified SPDX HTML-comment header.

Files:

  • skills/nemo-fabric-integrate/references/sdk-api-inventory.md
  • skills/nemo-fabric-integrate/references/results-and-errors.md
  • skills/nemo-fabric-integrate/references/config-mapping.md
  • skills/nemo-fabric-integrate/SKILL.md
skills/**

📄 CodeRabbit inference engine (AGENTS.md)

skills/**: Keep consumer skills under skills/ self-contained and based only on public Python SDK contracts and published documentation; do not include repository internals.
Do not add repository-internal contribution guidance to consumer skills; consumer skills are intended to be exportable into external projects.
Consumer skills should link to public GitHub documentation and example URLs rather than a docs-site domain so they remain portable when exported.

Files:

  • skills/nemo-fabric-integrate/references/sdk-api-inventory.md
  • skills/nemo-fabric-integrate/references/results-and-errors.md
  • skills/nemo-fabric-integrate/references/config-mapping.md
  • skills/nemo-fabric-integrate/SKILL.md
skills/nemo-fabric-integrate/**

📄 CodeRabbit inference engine (AGENTS.md)

Maintain the typed Python SDK integration guidance for the skills/nemo-fabric-integrate consumer skill.

Files:

  • skills/nemo-fabric-integrate/references/sdk-api-inventory.md
  • skills/nemo-fabric-integrate/references/results-and-errors.md
  • skills/nemo-fabric-integrate/references/config-mapping.md
  • skills/nemo-fabric-integrate/SKILL.md
{docs/sdk/python.mdx,schemas/SCHEMA.md,docs/reference/api/**,skills/**}

📄 CodeRabbit inference engine (AGENTS.md)

Keep the Python/Rust binding contract, JSON Schema notes, generated API references, and consumer skills current and in parity when the public API changes.

Files:

  • skills/nemo-fabric-integrate/references/sdk-api-inventory.md
  • skills/nemo-fabric-integrate/references/results-and-errors.md
  • skills/nemo-fabric-integrate/references/config-mapping.md
  • skills/nemo-fabric-integrate/SKILL.md
{README.md,docs/**,examples/**,skills/**}

📄 CodeRabbit inference engine (AGENTS.md)

Do not move release-history policy into user-facing documentation; if RELEASING.md or CHANGELOG.md is introduced, place that policy there.

Files:

  • skills/nemo-fabric-integrate/references/sdk-api-inventory.md
  • skills/nemo-fabric-integrate/references/results-and-errors.md
  • skills/nemo-fabric-integrate/references/config-mapping.md
  • skills/nemo-fabric-integrate/SKILL.md
{*.md,**/*.md,**/*.mdx,**/*.ipynb}

⚙️ CodeRabbit configuration file

{*.md,**/*.md,**/*.mdx,**/*.ipynb}: Enforce the product name in user-facing prose: use "NVIDIA NeMo Fabric" on first use and "NeMo Fabric" thereafter. Flag standalone capitalized "Fabric" when it refers to the product. Do not flag the lowercase fabric CLI command, package/import/crate names, code identifiers, API symbols, configuration keys, file paths, or unrelated generic uses of the word.

Files:

  • skills/nemo-fabric-integrate/references/sdk-api-inventory.md
  • skills/nemo-fabric-integrate/references/results-and-errors.md
  • skills/nemo-fabric-integrate/references/config-mapping.md
  • skills/nemo-fabric-integrate/SKILL.md
**/SKILL.md

📄 CodeRabbit inference engine (.agents/skills/README.md)

Each maintainer skill file must begin with YAML frontmatter containing at least name and description.

Files:

  • skills/nemo-fabric-integrate/SKILL.md

⚙️ CodeRabbit configuration file

**/SKILL.md: Do not flag SKILL.md files for missing SPDX headers. Skill entrypoints intentionally start with YAML frontmatter instead.
Verify that every SKILL.md keeps valid YAML frontmatter with at least name and description fields before the Markdown body.

Files:

  • skills/nemo-fabric-integrate/SKILL.md
🧠 Learnings (1)
📓 Common learnings
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric

Timestamp: 2026-08-06T18:18:58.365Z
Learning: Use branch prefixes `feat/`, `fix/`, `docs/`, `test/`, or `refactor/`.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric

Timestamp: 2026-08-06T18:18:58.365Z
Learning: Name branches after the work and never include Linear ticket IDs or slugs.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric

Timestamp: 2026-08-06T18:18:58.365Z
Learning: Use Conventional Commit PR titles in the form `<type>: <summary>`; reserve `fix` for actual product bugs, not CI, documentation, or chores.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric

Timestamp: 2026-08-06T18:18:58.365Z
Learning: Use signed-off commits for pull-request work with `git commit -s`.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric

Timestamp: 2026-08-06T18:18:58.365Z
Learning: When creating a pull request from the current branch, target the upstream repository rather than a fork.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric

Timestamp: 2026-08-06T18:18:58.365Z
Learning: If repository-local PR guidance conflicts with generic GitHub connector or plugin guidance, follow the repository-local guidance for PR body format and review handoff details.
🔇 Additional comments (6)
skills/nemo-fabric-integrate/SKILL.md (1)

3-16: LGTM!

Also applies to: 34-34, 312-312

skills/nemo-fabric-integrate/references/config-mapping.md (1)

10-10: LGTM!

skills/nemo-fabric-integrate/references/sdk-api-inventory.md (1)

58-59: LGTM!

Also applies to: 77-77

skills/nemo-fabric-integrate/references/results-and-errors.md (3)

44-48: LGTM!


68-68: 🗄️ Data Integrity & Integration

Keep the retryability claim. ErrorInfo exposes retryable, and adapter and runtime producers populate it for retryable failures.

			> Likely an incorrect or invalid review comment.

38-42: 🗄️ Data Integrity & Integration

Document only guaranteed correlation-ID formats. The Python layer generates request- by default, but runtime_id and invocation_id come from the native extension. The public binding and schemas specify only strings, not prefixes. Keep these prefixes only if the native API contract guarantees them; otherwise remove the format claim and retain the opaque-ID guidance.

Comment thread skills/nemo-fabric-integrate/references/results-and-errors.md Outdated
Title-case the consumer skill table header and remove an unsupported claim that non-success results can omit error metadata. Keep status as the authoritative success signal without expanding runtime behavior.

Validation: skill quick validator; JSON parsing; git diff --check; focused Codex adapter contract test.
Signed-off-by: Allan Enemark <exactly.allan@gmail.com>

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
skills/nemo-fabric-integrate/SKILL.md (1)

3-16: 🗄️ Data Integrity & Integration | 🟡 Minor | ⚡ Quick win

Keep an explicit consumer-only exclusion. The evals cover adapter contributions but not core, binding, or other repository-maintainer tasks. Add a short exclusion that routes repository work to .agents/skills/, and add negative evaluations for these maintainer categories.

🤖 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 `@skills/nemo-fabric-integrate/SKILL.md` around lines 3 - 16, Update the skill
description in “Integrate NVIDIA NeMo Fabric Through The Python SDK” with a
concise exclusion stating that repository-maintainer work belongs in
.agents/skills/. Add negative evaluations covering core, binding, and other
repository-maintainer tasks, while preserving the existing consumer integration
scope.
🤖 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 `@skills/nemo-fabric-integrate/SKILL.md`:
- Around line 3-16: Update the skill description in “Integrate NVIDIA NeMo
Fabric Through The Python SDK” with a concise exclusion stating that
repository-maintainer work belongs in .agents/skills/. Add negative evaluations
covering core, binding, and other repository-maintainer tasks, while preserving
the existing consumer integration scope.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Enterprise

Run ID: 4ceee5d6-23f0-4c2c-afb8-f8e9a964c7b8

📥 Commits

Reviewing files that changed from the base of the PR and between 3b51a31 and 47134f7.

📒 Files selected for processing (3)
  • skills/README.md
  • skills/nemo-fabric-integrate/SKILL.md
  • skills/nemo-fabric-integrate/references/results-and-errors.md
📜 Review details
🧰 Additional context used
📓 Path-based instructions (13)
**/*.{md,rst}

📄 CodeRabbit inference engine (.agents/skills/contribute-api/SKILL.md)

Update documentation and examples in the same branch as the public API change.

Files:

  • skills/README.md
  • skills/nemo-fabric-integrate/SKILL.md
  • skills/nemo-fabric-integrate/references/results-and-errors.md
**/*

📄 CodeRabbit inference engine (.agents/skills/karpathy-guidelines/SKILL.md)

**/*: 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.

**/*: Always spell NVIDIA in all caps; do not use Nvidia, nvidia, nVidia, nVIDIA, or NV.
Use an NVIDIA before a noun, because the name begins with an “en” sound.
Do not add a registered trademark symbol after NVIDIA when referring to the company; use trademark symbols with product names only when required by the document type or legal guidance.
Verify official capitalization, spacing, hyphenation, and spelling for NVIDIA and third-party product names; do not rewrite official product names for grammar or title-case rules.
Precede NVIDIA product names with NVIDIA on first mention when natural and accurate, and link the first mention when the destination helps the reader.
On first use, include the company name and full model qualifier when it helps identify the model; preserve official capitalization and punctuation, and use shorter family names only after establishing the full name.
For learning-oriented and developer content, do not force trademark symbols unless explicitly required; for press, ...

Files:

  • skills/README.md
  • skills/nemo-fabric-integrate/SKILL.md
  • skills/nemo-fabric-integrate/references/results-and-errors.md
**/*.{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 spell NVIDIA in all caps; do not use Nvidia, nvidia, or NV.
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 as here or read 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.
Use can for possibility and reserve may for permission.
Use after for temporal relationships instead of once, and prefer refer to over see when 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:

  • skills/README.md
  • skills/nemo-fabric-integrate/SKILL.md
  • skills/nemo-fabric-integrate/references/results-and-errors.md
**/*.{md,rst,txt,adoc}

📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-language-mechanics.md)

**/*.{md,rst,txt,adoc}: For technical documentation, use professional, active, conversational, engaging, precise, and plain-English prose. Prefer active voice, present tense, short sentences, and scannable paragraphs. Avoid casual or imprecise language, swearing, threats, insults, jokes, puns, culture-specific idioms, marketing exaggeration, and unsupported third-party comparisons.
Use can for possibility and reserve may for permission; use after for temporal order; use refer to for cross-references; prefer short direct sentences and specific verbs; avoid unnecessary please in technical documentation.
Prefer active voice when the actor matters. Passive voice is acceptable when the actor is unknown or irrelevant, when the action or result is the focus, or in programmer documentation.
Use natural contractions in conversational technical prose, but do not force them in formal legal copy, API references, or generated text.
Prefer simpler English over Latinisms: use for example or such as instead of e.g., and so on instead of etc., that is instead of i.e., compared to instead of vs., and by, through, or using instead of via. Use industry-standard terms such as in silico, in vitro, and in vivo when appropriate, and italicize them in running text.
Use that without commas for essential clauses, and which with commas for nonessential clauses.
Format dates and times clearly: spell out months in body text; use forms such as June 12, 2025; avoid numeric or ordinal dates; capitalize days; use 12-hour time when appropriate; include a space before a.m. or p.m.; use ET and PT for needed time zones; avoid 24/7; and prefer from 12:30 to 1:00 p.m. for prose ranges.
Format numbers consistently: spell out zero through nine in body text, use numerals for 10 or greater and for technical values, use commas in thousands, do not begin a sentence with a numeral, spell out ordinals, and use numerals consistently within a category wh...

Files:

  • skills/README.md
  • skills/nemo-fabric-integrate/SKILL.md
  • skills/nemo-fabric-integrate/references/results-and-errors.md
**/*.{md,mdx,yml,py,rs,sh}

📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)

Keep documentation aligned with current NeMo Fabric behavior, repository layout, entry points, commands, package names, APIs, bindings, and support claims.

Files:

  • skills/README.md
  • skills/nemo-fabric-integrate/SKILL.md
  • skills/nemo-fabric-integrate/references/results-and-errors.md
**/*.{md,mdx}

📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)

**/*.{md,mdx}: Use the full product name NVIDIA NeMo Fabric on first use, typically in the title and H1; use NeMo Fabric thereafter. Use fabric alone only for the CLI tool and surround it with backticks.
Treat incorrect or stale commands, package names, paths, APIs, support claims, procedures, examples, terminology, or public behavior documentation as blocking issues.
Capitalize NVIDIA correctly and format code, commands, paths, and filenames as inline code where needed.
Use title case for technical-documentation headings.
Introduce code blocks, tables, and lists with complete lead-in sentences; ensure examples match current APIs and build commands.
Use descriptive anchor text, avoid raw URLs and generic labels such as here, and use repository-relative .mdx paths for links within docs/.
Prefer active voice, present tense, short sentences, plain English, consistent terminology, and imperative, parallel, scannable procedures.
Use after instead of once when expressing temporal sequence, and use can rather than may when describing possibility rather than permission.
Avoid ambiguous numeric dates and ordinal dates in body text.
For learning-oriented documentation, do not force trademark symbols unless the source document explicitly requires them.
When reporting documentation-review findings, lead with Must fix, Should fix, and Nice to have categories; include file path, line reference, current problem, rationale, and a concrete rewrite or direction.

Files:

  • skills/README.md
  • skills/nemo-fabric-integrate/SKILL.md
  • skills/nemo-fabric-integrate/references/results-and-errors.md
**/*.md

📄 CodeRabbit inference engine (CONTRIBUTING.md)

Update relevant SDK, API reference, adapter, example, integration, and support documentation when the corresponding public surface changes.

Files:

  • skills/README.md
  • skills/nemo-fabric-integrate/SKILL.md
  • skills/nemo-fabric-integrate/references/results-and-errors.md
**/*.{html,md}

📄 CodeRabbit inference engine (CONTRIBUTING.md)

HTML and Markdown files must use the specified SPDX HTML-comment header.

Files:

  • skills/README.md
  • skills/nemo-fabric-integrate/SKILL.md
  • skills/nemo-fabric-integrate/references/results-and-errors.md
skills/**

📄 CodeRabbit inference engine (AGENTS.md)

skills/**: Keep consumer skills under skills/ self-contained and dependent only on supported public Python SDK contracts and published documentation; do not add repository-internal contribution guidance.
Consumer skills must use public GitHub documentation and example URLs rather than docs-site domains so they remain portable when exported.

Files:

  • skills/README.md
  • skills/nemo-fabric-integrate/SKILL.md
  • skills/nemo-fabric-integrate/references/results-and-errors.md
{docs/sdk/python.mdx,schemas/SCHEMA.md,docs/reference/api/**,skills/**}

📄 CodeRabbit inference engine (AGENTS.md)

When the public API changes, keep the Python/Rust binding contract, JSON Schema notes, generated API references, and consumer skills current and in parity.

Files:

  • skills/README.md
  • skills/nemo-fabric-integrate/SKILL.md
  • skills/nemo-fabric-integrate/references/results-and-errors.md
{*.md,**/*.md,**/*.mdx,**/*.ipynb}

⚙️ CodeRabbit configuration file

{*.md,**/*.md,**/*.mdx,**/*.ipynb}: Enforce the product name in user-facing prose: use "NVIDIA NeMo Fabric" on first use and "NeMo Fabric" thereafter. Flag standalone capitalized "Fabric" when it refers to the product. Do not flag the lowercase fabric CLI command, package/import/crate names, code identifiers, API symbols, configuration keys, file paths, or unrelated generic uses of the word.

Files:

  • skills/README.md
  • skills/nemo-fabric-integrate/SKILL.md
  • skills/nemo-fabric-integrate/references/results-and-errors.md
**/SKILL.md

📄 CodeRabbit inference engine (.agents/skills/README.md)

Each maintainer skill file must begin with YAML frontmatter containing at least name and description.

Files:

  • skills/nemo-fabric-integrate/SKILL.md

⚙️ CodeRabbit configuration file

**/SKILL.md: Do not flag SKILL.md files for missing SPDX headers. Skill entrypoints intentionally start with YAML frontmatter instead.
Verify that every SKILL.md keeps valid YAML frontmatter with at least name and description fields before the Markdown body.

Files:

  • skills/nemo-fabric-integrate/SKILL.md
skills/nemo-fabric-integrate/**

📄 CodeRabbit inference engine (AGENTS.md)

Maintain the consumer skills/nemo-fabric-integrate skill for typed Python SDK integration and keep its SDK guide, model, and type details current.

Files:

  • skills/nemo-fabric-integrate/SKILL.md
  • skills/nemo-fabric-integrate/references/results-and-errors.md
🧠 Learnings (1)
📓 Common learnings
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric

Timestamp: 2026-08-06T18:45:30.626Z
Learning: Use one of the branch prefixes `feat/`, `fix/`, `docs/`, `test/`, or `refactor/`.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric

Timestamp: 2026-08-06T18:45:30.626Z
Learning: Name branches after the work and never include Linear ticket IDs or slugs in branch names.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric

Timestamp: 2026-08-06T18:45:30.626Z
Learning: Use Conventional Commit PR titles in the form `<type>: <summary>`; reserve `fix` for actual product bugs, not CI, documentation, or chores.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric

Timestamp: 2026-08-06T18:45:30.626Z
Learning: Use signed-off commits for pull-request work with `git commit -s`.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric

Timestamp: 2026-08-06T18:45:30.626Z
Learning: When creating a pull request from the current branch, target the upstream repository rather than a fork.
Learnt from: CR
Repo: NVIDIA/NeMo-Fabric

Timestamp: 2026-08-06T18:45:30.626Z
Learning: Follow repository-local PR guidance, such as the `prepare-pr` skill, when it conflicts with generic GitHub connector or plugin guidance.
🔇 Additional comments (3)
skills/README.md (1)

38-41: LGTM!

Also applies to: 55-68

skills/nemo-fabric-integrate/SKILL.md (1)

34-34: LGTM!

Also applies to: 295-296, 311-311

skills/nemo-fabric-integrate/references/results-and-errors.md (1)

17-17: LGTM!

Also applies to: 38-48, 68-68

Comment thread skills/nemo-fabric-integrate/evals/evals.json
@AnuradhaKaruppiah

Copy link
Copy Markdown
Collaborator

/ok to test 47134f7

@exactlyallan
exactlyallan merged commit de9d924 into NVIDIA:main Aug 7, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants