docs(skills): update typed OpenTelemetry guidance - #557
Conversation
|
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:
WalkthroughThe observability skill and supporting references now distinguish NeMo Relay 0.6 from 0.7, including configuration versions, exporters, projections, lifecycle handling, runtime requirements, authentication, validation, troubleshooting, and evaluation expectations. ChangesObservability version awareness
Estimated code review effort: 2 (Simple) | ~10 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
github-actions
Bot
added
size:M
|
/nvskills-ci |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 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-relay-plugin-observability/evals/evals.json`:
- Around line 136-143: Update the eval 010 oracle text in the ground_truth field
to replace “exporter-owned runtime behavior” with “subscriber-owned runtime
behavior,” while preserving the surrounding gRPC guidance unchanged.
In `@skills/nemo-relay-plugin-observability/references/opentelemetry.md`:
- Around line 42-44: Restore projection-control guidance in both references: in
skills/nemo-relay-plugin-observability/references/opentelemetry.md (lines
42-44), preserve the per-endpoint matrix and state that mark_projection,
mark_exclude_names, and attribute_mappings apply to full and openinference but
are ignored only by gen_ai, while semantic_selector and capture_content remain
unsupported; in
skills/nemo-relay-plugin-observability/references/openinference.md (lines
38-40), retain typed openinference endpoint guidance and remove the blanket
fixed-projection wording.
In `@skills/nemo-relay-plugin-observability/skill-card.md`:
- Around line 1-2: Add the repository-approved SPDX license header as an HTML
comment at the beginning of the skill-card.md document, before the existing “##
Description” heading, without changing the Markdown body.
🪄 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: 8d3e99ab-d85f-4f3c-b97b-e71b94605751
📒 Files selected for processing (9)
skills/README.mdskills/nemo-relay-debug-runtime-integration/SKILL.mdskills/nemo-relay-get-started/references/cli-try-now.mdskills/nemo-relay-plugin-observability/SKILL.mdskills/nemo-relay-plugin-observability/evals/evals.jsonskills/nemo-relay-plugin-observability/references/atof.mdskills/nemo-relay-plugin-observability/references/openinference.mdskills/nemo-relay-plugin-observability/references/opentelemetry.mdskills/nemo-relay-plugin-observability/skill-card.md
📜 Review details
🧰 Additional context used
📓 Path-based instructions (9)
**/*.{md,rst,html,txt}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-brand-terminology.md)
**/*.{md,rst,html,txt}: Always spellNVIDIAin all caps. Do not useNvidia,nvidia,nVidia,nVIDIA, orNV.
Usean NVIDIAbefore a noun because the name starts with an 'en' sound.
Do not add a registered trademark symbol afterNVIDIAwhen referring to the company.
Use trademark symbols with product names only when the document type or legal guidance requires them.
Verify official capitalization, spacing, and hyphenation for product names.
Precede NVIDIA product names withNVIDIAon first mention when it is natural and accurate.
Do not rewrite product names for grammar or title-case rules.
Preserve third-party product names according to the owner's spelling.
Include the company name and full model qualifier on first use when it helps identify the model.
Preserve the official capitalization and punctuation of model names.
Use shorter family names only after the full name is established.
Spell out a term on first use and put the acronym in parentheses unless the acronym is widely understood by the intended audience.
Use the acronym on later mentions after it has been defined.
For long documents, reintroduce the full term if readers might lose context.
Form plurals of acronyms withs, not an apostrophe, such asGPUs.
In headings, common acronyms can remain abbreviated. Spell out the term in the first or second sentence of the body.
Common terms such asCPU,GPU,PC,API, andUIusually do not need to be spelled out for developer audiences.
Files:
skills/nemo-relay-debug-runtime-integration/SKILL.mdskills/nemo-relay-get-started/references/cli-try-now.mdskills/nemo-relay-plugin-observability/skill-card.mdskills/nemo-relay-plugin-observability/references/openinference.mdskills/nemo-relay-plugin-observability/references/atof.mdskills/README.mdskills/nemo-relay-plugin-observability/SKILL.mdskills/nemo-relay-plugin-observability/references/opentelemetry.md
**/*.{md,rst,html}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-brand-terminology.md)
Link the first mention of a product name when the destination helps the reader.
Files:
skills/nemo-relay-debug-runtime-integration/SKILL.mdskills/nemo-relay-get-started/references/cli-try-now.mdskills/nemo-relay-plugin-observability/skill-card.mdskills/nemo-relay-plugin-observability/references/openinference.mdskills/nemo-relay-plugin-observability/references/atof.mdskills/README.mdskills/nemo-relay-plugin-observability/SKILL.mdskills/nemo-relay-plugin-observability/references/opentelemetry.md
**/*.{md,rst,txt}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
Spell
NVIDIAin all caps. Do not useNvidia,nvidia, orNV.
Files:
skills/nemo-relay-debug-runtime-integration/SKILL.mdskills/nemo-relay-get-started/references/cli-try-now.mdskills/nemo-relay-plugin-observability/skill-card.mdskills/nemo-relay-plugin-observability/references/openinference.mdskills/nemo-relay-plugin-observability/references/atof.mdskills/README.mdskills/nemo-relay-plugin-observability/SKILL.mdskills/nemo-relay-plugin-observability/references/opentelemetry.md
**/*.{md,rst}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
**/*.{md,rst}: 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 steps. Keep steps parallel and split long procedures into smaller tasks.
Prefer active voice, present tense, short sentences, contractions, and plain English.
Usecanfor possibility and reservemayfor permission.
Useafterfor temporal relationships instead ofonce.
Preferrefer tooverseewhen the wording points readers to another resource.
Avoid culture-specific idioms, unnecessary Latinisms, jokes, and marketing exaggeration in technical docs.
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 include commas in thousands.
Do not add trademark symbols to learning-oriented docs unless the source, platform, or legal guidance explicitly requires them.
Files:
skills/nemo-relay-debug-runtime-integration/SKILL.mdskills/nemo-relay-get-started/references/cli-try-now.mdskills/nemo-relay-plugin-observability/skill-card.mdskills/nemo-relay-plugin-observability/references/openinference.mdskills/nemo-relay-plugin-observability/references/atof.mdskills/README.mdskills/nemo-relay-plugin-observability/SKILL.mdskills/nemo-relay-plugin-observability/references/opentelemetry.md
**/*.md
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-technical-docs.md)
**/*.md: Use title case consistently in technical documentation headings
Avoid quotation marks, ampersands, and exclamation marks in headings
Keep product, event, research, and whitepaper names in their official title case
Use title case for table headers
Do not force social-media sentence case into technical docs
Format code elements, commands, parameters, package names, and expressions in monospace
Format directories, file names, and paths in monospace using backticks
Use angle brackets inside monospace for variables inside paths, such as/home/<username>/.login
Format error messages and strings in quotation marks, keeping literal code strings in code formatting when clearer
Format UI buttons, menus, fields, and labels in bold
Use angle brackets between UI labels for menu paths, such as File > Save As
Use italics for new terms on first use, sparingly and only when introducing the term
Use italics for publication titles
Format keyboard shortcuts in plain text, such as Press Ctrl+Alt+Delete
Use owner/repo link text for GitHub repositories, preferring[NVIDIA/NeMo](link)over prose references like 'the GitHub repo'
Introduce every code block with a complete sentence
Do not make a code block complete the grammar of the previous sentence
Do not continue a sentence after a code block
Use syntax highlighting when the format supports it for code blocks
Avoid the word 'snippet' unless the surrounding docs already use it as a term of art
Keep inline method, function, and class references consistent with nearby docs, omitting empty parentheses for prose readability when no call is shown
Use descriptive anchor text that matches the destination title when possible for links
Avoid raw URLs in running text
Avoid generic anchor text such as 'here,' 'this page,' and 'read more'
Include acronyms in link text when a linked term includes an acronym
Do not link long sentences or multiple sentences
Avoid links that pull readers away from a procedure unless the link is a p...
Files:
skills/nemo-relay-debug-runtime-integration/SKILL.mdskills/nemo-relay-get-started/references/cli-try-now.mdskills/nemo-relay-plugin-observability/skill-card.mdskills/nemo-relay-plugin-observability/references/openinference.mdskills/nemo-relay-plugin-observability/references/atof.mdskills/README.mdskills/nemo-relay-plugin-observability/SKILL.mdskills/nemo-relay-plugin-observability/references/opentelemetry.md
**/SKILL.md
📄 CodeRabbit inference engine (AGENTS.md)
SKILL.mdfiles are skill entrypoints and must start with YAML frontmatter containing at leastnameanddescription.
Files:
skills/nemo-relay-debug-runtime-integration/SKILL.mdskills/nemo-relay-plugin-observability/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-relay-debug-runtime-integration/SKILL.mdskills/nemo-relay-plugin-observability/SKILL.md
**/*.{md,mdx}
📄 CodeRabbit inference engine (AGENTS.md)
Update
README.md,fern/, package READMEs, and binding-support notes when public behavior, package names, examples, or supported bindings change.
**/*.{md,mdx}: Prefer the documented public API, not internal shortcuts
Keep package names, repo references, and build commands current
Keep release-process and release-notes guidance in repo-maintainer docs such asRELEASING.md, not as user-facing docs pages orCHANGELOG.md
Keep stable user-facing wrappers atscripts/root in docs and examples; only point at namespaced helper paths when documenting internal maintenance work
When detailed dynamic plugin guides exist, keep Rust native plugin examples, Python worker plugin examples, andgrpc-v1protocol details on separate pagesIf links in documentation change, run
just docs-linkcheck.
Files:
skills/nemo-relay-debug-runtime-integration/SKILL.mdskills/nemo-relay-get-started/references/cli-try-now.mdskills/nemo-relay-plugin-observability/skill-card.mdskills/nemo-relay-plugin-observability/references/openinference.mdskills/nemo-relay-plugin-observability/references/atof.mdskills/README.mdskills/nemo-relay-plugin-observability/SKILL.mdskills/nemo-relay-plugin-observability/references/opentelemetry.md
**/*.{md,markdown,mdx}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Add the SPDX license header to all Markdown/MDX documentation files using the HTML comment block form.
Files:
skills/nemo-relay-debug-runtime-integration/SKILL.mdskills/nemo-relay-get-started/references/cli-try-now.mdskills/nemo-relay-plugin-observability/skill-card.mdskills/nemo-relay-plugin-observability/references/openinference.mdskills/nemo-relay-plugin-observability/references/atof.mdskills/README.mdskills/nemo-relay-plugin-observability/SKILL.mdskills/nemo-relay-plugin-observability/references/opentelemetry.md
**/*
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
**/*: Format changed files with the language-native formatter before the final lint/test pass.
If dynamic plugin behavior changed, usemaintain-dynamic-pluginsand include the native SDK, worker protocol, Python SDK, docs, packaging, and Codecov surfaces in the validation plan.
If code changes alter APIs, bindings, commands, paths, packaging behavior, observability/adaptive semantics, or documented best practices, update any dependent maintainer or consumer skills in the same branch.
During iteration, preferuv run pre-commit run --files <changed files...>.
Before review or handoff, runuv run pre-commit run --all-files.
Files:
skills/nemo-relay-debug-runtime-integration/SKILL.mdskills/nemo-relay-get-started/references/cli-try-now.mdskills/nemo-relay-plugin-observability/skill-card.mdskills/nemo-relay-plugin-observability/references/openinference.mdskills/nemo-relay-plugin-observability/references/atof.mdskills/README.mdskills/nemo-relay-plugin-observability/SKILL.mdskills/nemo-relay-plugin-observability/references/opentelemetry.mdskills/nemo-relay-plugin-observability/evals/evals.json
🪛 LanguageTool
skills/nemo-relay-plugin-observability/SKILL.md
[style] ~121-~121: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ry.mdfor OTLP/OpenTelemetry traces. - Loadreferences/openinference.md` for the s...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🔇 Additional comments (11)
skills/nemo-relay-plugin-observability/SKILL.md (1)
3-3: LGTM!Also applies to: 20-33, 44-48, 71-71, 97-108, 121-122
skills/README.md (1)
68-68: LGTM!skills/nemo-relay-get-started/references/cli-try-now.md (1)
104-107: LGTM!Also applies to: 117-117
skills/nemo-relay-plugin-observability/references/atof.md (1)
15-17: LGTM!Also applies to: 27-27
skills/nemo-relay-plugin-observability/references/openinference.md (2)
13-19: LGTM!Also applies to: 28-37
56-60: LGTM!skills/nemo-relay-plugin-observability/references/opentelemetry.md (2)
13-22: LGTM!Also applies to: 23-41
45-62: LGTM!Also applies to: 89-90
skills/nemo-relay-debug-runtime-integration/SKILL.md (1)
67-71: LGTM!skills/nemo-relay-plugin-observability/evals/evals.json (2)
7-13: LGTM!Also applies to: 23-29, 120-127
182-194: LGTM!Also applies to: 197-207, 216-221, 248-248
There was a problem hiding this comment.
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-relay-debug-runtime-integration/BENCHMARK.md`:
- Around line 72-78: Update the scoring tables in
skills/nemo-relay-debug-runtime-integration/BENCHMARK.md lines 72-78,
skills/nemo-relay-get-started/BENCHMARK.md lines 72-78, and
skills/nemo-relay-plugin-observability/BENCHMARK.md lines 72-78: rename the
“Scored signals” header to “Scored Signals” and add a complete-sentence
introduction immediately before each table.
- Line 1: Add the repository-approved SPDX HTML comment header before the title
in skills/nemo-relay-debug-runtime-integration/BENCHMARK.md at lines 1-1,
skills/nemo-relay-get-started/BENCHMARK.md at lines 1-1, and
skills/nemo-relay-plugin-observability/BENCHMARK.md at lines 1-1; keep each
existing benchmark heading unchanged.
- Line 37: Correct the score deltas in all six benchmark tables: in
skills/nemo-relay-debug-runtime-integration/BENCHMARK.md lines 37-37 and
skill-card.md lines 68-68, change 70% → 97% to +27; in
skills/nemo-relay-get-started/BENCHMARK.md lines 37-40 and skill-card.md lines
74-76, change 87% → 73% to -14, 25% → 71% to +46, and 48% → 95% to +47; in
skills/nemo-relay-plugin-observability/BENCHMARK.md lines 37-37 and
skill-card.md lines 70-70, change 65% → 93% to +28.
In `@skills/nemo-relay-debug-runtime-integration/skill-card.md`:
- Around line 14-17: Resolve Markdown spacing warnings by adding the required
blank lines around headings and affected content in
skills/nemo-relay-debug-runtime-integration/skill-card.md at lines 14-17, 32,
38, 44, 47, 65-66, and 75; skills/nemo-relay-get-started/skill-card.md at lines
37-38, 52, 70-71, and 80; and
skills/nemo-relay-plugin-observability/skill-card.md at lines 49-50, 67-68, and
77. Preserve all existing text and structure apart from the whitespace
corrections.
In `@skills/nemo-relay-plugin-observability/skill-card.md`:
- Line 68: Update the results table header in skill-card.md from “Baseline →
Skill” to “Baseline → Skill Uplift” for both benchmark columns, preserving the
existing table structure and cell values.
🪄 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: 19ecd233-3e28-44d7-a0f0-7483e24fa7d2
📒 Files selected for processing (9)
skills/nemo-relay-debug-runtime-integration/BENCHMARK.mdskills/nemo-relay-debug-runtime-integration/skill-card.mdskills/nemo-relay-debug-runtime-integration/skill.oms.sigskills/nemo-relay-get-started/BENCHMARK.mdskills/nemo-relay-get-started/skill-card.mdskills/nemo-relay-get-started/skill.oms.sigskills/nemo-relay-plugin-observability/BENCHMARK.mdskills/nemo-relay-plugin-observability/skill-card.mdskills/nemo-relay-plugin-observability/skill.oms.sig
📜 Review details
🧰 Additional context used
📓 Path-based instructions (8)
**/*
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
**/*: Format changed files with the language-native formatter before the final lint/test pass.
If dynamic plugin behavior changed, usemaintain-dynamic-pluginsand include the native SDK, worker protocol, Python SDK, docs, packaging, and Codecov surfaces in the validation plan.
If code changes alter APIs, bindings, commands, paths, packaging behavior, observability/adaptive semantics, or documented best practices, update any dependent maintainer or consumer skills in the same branch.
During iteration, preferuv run pre-commit run --files <changed files...>.
Before review or handoff, runuv run pre-commit run --all-files.
Files:
skills/nemo-relay-plugin-observability/skill.oms.sigskills/nemo-relay-plugin-observability/skill-card.mdskills/nemo-relay-get-started/skill.oms.sigskills/nemo-relay-plugin-observability/BENCHMARK.mdskills/nemo-relay-get-started/BENCHMARK.mdskills/nemo-relay-debug-runtime-integration/skill-card.mdskills/nemo-relay-debug-runtime-integration/skill.oms.sigskills/nemo-relay-debug-runtime-integration/BENCHMARK.mdskills/nemo-relay-get-started/skill-card.md
**/*.{md,rst,html,txt}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-brand-terminology.md)
**/*.{md,rst,html,txt}: Always spellNVIDIAin all caps. Do not useNvidia,nvidia,nVidia,nVIDIA, orNV.
Usean NVIDIAbefore a noun because the name starts with an 'en' sound.
Do not add a registered trademark symbol afterNVIDIAwhen referring to the company.
Use trademark symbols with product names only when the document type or legal guidance requires them.
Verify official capitalization, spacing, and hyphenation for product names.
Precede NVIDIA product names withNVIDIAon first mention when it is natural and accurate.
Do not rewrite product names for grammar or title-case rules.
Preserve third-party product names according to the owner's spelling.
Include the company name and full model qualifier on first use when it helps identify the model.
Preserve the official capitalization and punctuation of model names.
Use shorter family names only after the full name is established.
Spell out a term on first use and put the acronym in parentheses unless the acronym is widely understood by the intended audience.
Use the acronym on later mentions after it has been defined.
For long documents, reintroduce the full term if readers might lose context.
Form plurals of acronyms withs, not an apostrophe, such asGPUs.
In headings, common acronyms can remain abbreviated. Spell out the term in the first or second sentence of the body.
Common terms such asCPU,GPU,PC,API, andUIusually do not need to be spelled out for developer audiences.
Files:
skills/nemo-relay-plugin-observability/skill-card.mdskills/nemo-relay-plugin-observability/BENCHMARK.mdskills/nemo-relay-get-started/BENCHMARK.mdskills/nemo-relay-debug-runtime-integration/skill-card.mdskills/nemo-relay-debug-runtime-integration/BENCHMARK.mdskills/nemo-relay-get-started/skill-card.md
**/*.{md,rst,html}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-brand-terminology.md)
Link the first mention of a product name when the destination helps the reader.
Files:
skills/nemo-relay-plugin-observability/skill-card.mdskills/nemo-relay-plugin-observability/BENCHMARK.mdskills/nemo-relay-get-started/BENCHMARK.mdskills/nemo-relay-debug-runtime-integration/skill-card.mdskills/nemo-relay-debug-runtime-integration/BENCHMARK.mdskills/nemo-relay-get-started/skill-card.md
**/*.{md,rst,txt}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
Spell
NVIDIAin all caps. Do not useNvidia,nvidia, orNV.
Files:
skills/nemo-relay-plugin-observability/skill-card.mdskills/nemo-relay-plugin-observability/BENCHMARK.mdskills/nemo-relay-get-started/BENCHMARK.mdskills/nemo-relay-debug-runtime-integration/skill-card.mdskills/nemo-relay-debug-runtime-integration/BENCHMARK.mdskills/nemo-relay-get-started/skill-card.md
**/*.{md,rst}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
**/*.{md,rst}: 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 steps. Keep steps parallel and split long procedures into smaller tasks.
Prefer active voice, present tense, short sentences, contractions, and plain English.
Usecanfor possibility and reservemayfor permission.
Useafterfor temporal relationships instead ofonce.
Preferrefer tooverseewhen the wording points readers to another resource.
Avoid culture-specific idioms, unnecessary Latinisms, jokes, and marketing exaggeration in technical docs.
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 include commas in thousands.
Do not add trademark symbols to learning-oriented docs unless the source, platform, or legal guidance explicitly requires them.
Files:
skills/nemo-relay-plugin-observability/skill-card.mdskills/nemo-relay-plugin-observability/BENCHMARK.mdskills/nemo-relay-get-started/BENCHMARK.mdskills/nemo-relay-debug-runtime-integration/skill-card.mdskills/nemo-relay-debug-runtime-integration/BENCHMARK.mdskills/nemo-relay-get-started/skill-card.md
**/*.md
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-technical-docs.md)
**/*.md: Use title case consistently in technical documentation headings
Avoid quotation marks, ampersands, and exclamation marks in headings
Keep product, event, research, and whitepaper names in their official title case
Use title case for table headers
Do not force social-media sentence case into technical docs
Format code elements, commands, parameters, package names, and expressions in monospace
Format directories, file names, and paths in monospace using backticks
Use angle brackets inside monospace for variables inside paths, such as/home/<username>/.login
Format error messages and strings in quotation marks, keeping literal code strings in code formatting when clearer
Format UI buttons, menus, fields, and labels in bold
Use angle brackets between UI labels for menu paths, such as File > Save As
Use italics for new terms on first use, sparingly and only when introducing the term
Use italics for publication titles
Format keyboard shortcuts in plain text, such as Press Ctrl+Alt+Delete
Use owner/repo link text for GitHub repositories, preferring[NVIDIA/NeMo](link)over prose references like 'the GitHub repo'
Introduce every code block with a complete sentence
Do not make a code block complete the grammar of the previous sentence
Do not continue a sentence after a code block
Use syntax highlighting when the format supports it for code blocks
Avoid the word 'snippet' unless the surrounding docs already use it as a term of art
Keep inline method, function, and class references consistent with nearby docs, omitting empty parentheses for prose readability when no call is shown
Use descriptive anchor text that matches the destination title when possible for links
Avoid raw URLs in running text
Avoid generic anchor text such as 'here,' 'this page,' and 'read more'
Include acronyms in link text when a linked term includes an acronym
Do not link long sentences or multiple sentences
Avoid links that pull readers away from a procedure unless the link is a p...
Files:
skills/nemo-relay-plugin-observability/skill-card.mdskills/nemo-relay-plugin-observability/BENCHMARK.mdskills/nemo-relay-get-started/BENCHMARK.mdskills/nemo-relay-debug-runtime-integration/skill-card.mdskills/nemo-relay-debug-runtime-integration/BENCHMARK.mdskills/nemo-relay-get-started/skill-card.md
**/*.{md,mdx}
📄 CodeRabbit inference engine (AGENTS.md)
Update
README.md,fern/, package READMEs, and binding-support notes when public behavior, package names, examples, or supported bindings change.
**/*.{md,mdx}: Prefer the documented public API, not internal shortcuts
Keep package names, repo references, and build commands current
Keep release-process and release-notes guidance in repo-maintainer docs such asRELEASING.md, not as user-facing docs pages orCHANGELOG.md
Keep stable user-facing wrappers atscripts/root in docs and examples; only point at namespaced helper paths when documenting internal maintenance work
When detailed dynamic plugin guides exist, keep Rust native plugin examples, Python worker plugin examples, andgrpc-v1protocol details on separate pagesIf links in documentation change, run
just docs-linkcheck.
Files:
skills/nemo-relay-plugin-observability/skill-card.mdskills/nemo-relay-plugin-observability/BENCHMARK.mdskills/nemo-relay-get-started/BENCHMARK.mdskills/nemo-relay-debug-runtime-integration/skill-card.mdskills/nemo-relay-debug-runtime-integration/BENCHMARK.mdskills/nemo-relay-get-started/skill-card.md
**/*.{md,markdown,mdx}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Add the SPDX license header to all Markdown/MDX documentation files using the HTML comment block form.
Files:
skills/nemo-relay-plugin-observability/skill-card.mdskills/nemo-relay-plugin-observability/BENCHMARK.mdskills/nemo-relay-get-started/BENCHMARK.mdskills/nemo-relay-debug-runtime-integration/skill-card.mdskills/nemo-relay-debug-runtime-integration/BENCHMARK.mdskills/nemo-relay-get-started/skill-card.md
🪛 markdownlint-cli2 (0.23.1)
skills/nemo-relay-plugin-observability/skill-card.md
[warning] 49-49: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 67-67: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 68-68: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
[warning] 77-77: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
skills/nemo-relay-debug-runtime-integration/skill-card.md
[warning] 14-14: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 17-17: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 32-32: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 38-38: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 44-44: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 47-47: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 65-65: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 66-66: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
[warning] 75-75: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
skills/nemo-relay-get-started/skill-card.md
[warning] 37-37: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 52-52: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 70-70: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 71-71: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
[warning] 80-80: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
🔇 Additional comments (8)
skills/nemo-relay-debug-runtime-integration/BENCHMARK.md (1)
3-36: LGTM!Also applies to: 38-71, 73-100
skills/nemo-relay-get-started/BENCHMARK.md (1)
3-36: LGTM!Also applies to: 41-71, 73-100
skills/nemo-relay-plugin-observability/BENCHMARK.md (1)
3-36: LGTM!Also applies to: 38-71, 73-100
skills/nemo-relay-debug-runtime-integration/skill-card.md (2)
12-13: LGTM!Also applies to: 15-28, 30-31, 33-37, 39-43, 45-46, 48-64, 67-67, 69-74
29-29: 📐 Maintainability & Code QualityRun
just docs-linkcheckfor the changed references.
skills/nemo-relay-debug-runtime-integration/skill-card.md#L29-L29: validate the changed releases reference.skills/nemo-relay-get-started/skill-card.md#L28-L34: validate the changed quick-start and integration references.As per coding guidelines,
just docs-linkcheckmust run when documentation links change.Source: Coding guidelines
skills/nemo-relay-get-started/skill-card.md (1)
12-27: LGTM!Also applies to: 35-36, 39-49, 53-69, 79-79, 81-81
skills/nemo-relay-plugin-observability/skill-card.md (1)
12-12: LGTM!Also applies to: 15-46, 47-48, 50-66, 69-69, 71-75, 78-78
skills/nemo-relay-debug-runtime-integration/skill.oms.sig (1)
1-1: 🔒 Security & PrivacyCryptographically verify all regenerated signature bundles.
skills/nemo-relay-debug-runtime-integration/skill.oms.sig#L1-L1: verify the DSSE signature and all embedded resource digests.skills/nemo-relay-get-started/skill.oms.sig#L1-L1: verify the DSSE signature and all embedded resource digests.skills/nemo-relay-plugin-observability/skill.oms.sig#L1-L1: verify the DSSE signature and all embedded resource digests.JSON validity alone does not establish signature or artifact integrity.
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 `@skills/nemo-relay-plugin-observability/references/openinference.md`:
- Around line 38-41: Update the 0.7 OpenInference guidance in the referenced
OpenTelemetry section to require secret injection through header_env and
prohibit resolved credentials in source, configuration, arguments, or
diagnostics. Keep the existing supported and unsupported option guidance
unchanged, and make the requirement specific to the unified
OpenTelemetrySubscriber path.
🪄 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: 4d55bc00-1c2f-4ea0-b9ca-9f47c89f9f71
📒 Files selected for processing (2)
skills/nemo-relay-plugin-observability/references/openinference.mdskills/nemo-relay-plugin-observability/references/opentelemetry.md
📜 Review details
🧰 Additional context used
📓 Path-based instructions (8)
**/*.{md,rst,html,txt}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-brand-terminology.md)
**/*.{md,rst,html,txt}: Always spellNVIDIAin all caps. Do not useNvidia,nvidia,nVidia,nVIDIA, orNV.
Usean NVIDIAbefore a noun because the name starts with an 'en' sound.
Do not add a registered trademark symbol afterNVIDIAwhen referring to the company.
Use trademark symbols with product names only when the document type or legal guidance requires them.
Verify official capitalization, spacing, and hyphenation for product names.
Precede NVIDIA product names withNVIDIAon first mention when it is natural and accurate.
Do not rewrite product names for grammar or title-case rules.
Preserve third-party product names according to the owner's spelling.
Include the company name and full model qualifier on first use when it helps identify the model.
Preserve the official capitalization and punctuation of model names.
Use shorter family names only after the full name is established.
Spell out a term on first use and put the acronym in parentheses unless the acronym is widely understood by the intended audience.
Use the acronym on later mentions after it has been defined.
For long documents, reintroduce the full term if readers might lose context.
Form plurals of acronyms withs, not an apostrophe, such asGPUs.
In headings, common acronyms can remain abbreviated. Spell out the term in the first or second sentence of the body.
Common terms such asCPU,GPU,PC,API, andUIusually do not need to be spelled out for developer audiences.
Files:
skills/nemo-relay-plugin-observability/references/opentelemetry.mdskills/nemo-relay-plugin-observability/references/openinference.md
**/*.{md,rst,html}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-brand-terminology.md)
Link the first mention of a product name when the destination helps the reader.
Files:
skills/nemo-relay-plugin-observability/references/opentelemetry.mdskills/nemo-relay-plugin-observability/references/openinference.md
**/*.{md,rst,txt}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
Spell
NVIDIAin all caps. Do not useNvidia,nvidia, orNV.
Files:
skills/nemo-relay-plugin-observability/references/opentelemetry.mdskills/nemo-relay-plugin-observability/references/openinference.md
**/*.{md,rst}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
**/*.{md,rst}: 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 steps. Keep steps parallel and split long procedures into smaller tasks.
Prefer active voice, present tense, short sentences, contractions, and plain English.
Usecanfor possibility and reservemayfor permission.
Useafterfor temporal relationships instead ofonce.
Preferrefer tooverseewhen the wording points readers to another resource.
Avoid culture-specific idioms, unnecessary Latinisms, jokes, and marketing exaggeration in technical docs.
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 include commas in thousands.
Do not add trademark symbols to learning-oriented docs unless the source, platform, or legal guidance explicitly requires them.
Files:
skills/nemo-relay-plugin-observability/references/opentelemetry.mdskills/nemo-relay-plugin-observability/references/openinference.md
**/*.md
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-technical-docs.md)
**/*.md: Use title case consistently in technical documentation headings
Avoid quotation marks, ampersands, and exclamation marks in headings
Keep product, event, research, and whitepaper names in their official title case
Use title case for table headers
Do not force social-media sentence case into technical docs
Format code elements, commands, parameters, package names, and expressions in monospace
Format directories, file names, and paths in monospace using backticks
Use angle brackets inside monospace for variables inside paths, such as/home/<username>/.login
Format error messages and strings in quotation marks, keeping literal code strings in code formatting when clearer
Format UI buttons, menus, fields, and labels in bold
Use angle brackets between UI labels for menu paths, such as File > Save As
Use italics for new terms on first use, sparingly and only when introducing the term
Use italics for publication titles
Format keyboard shortcuts in plain text, such as Press Ctrl+Alt+Delete
Use owner/repo link text for GitHub repositories, preferring[NVIDIA/NeMo](link)over prose references like 'the GitHub repo'
Introduce every code block with a complete sentence
Do not make a code block complete the grammar of the previous sentence
Do not continue a sentence after a code block
Use syntax highlighting when the format supports it for code blocks
Avoid the word 'snippet' unless the surrounding docs already use it as a term of art
Keep inline method, function, and class references consistent with nearby docs, omitting empty parentheses for prose readability when no call is shown
Use descriptive anchor text that matches the destination title when possible for links
Avoid raw URLs in running text
Avoid generic anchor text such as 'here,' 'this page,' and 'read more'
Include acronyms in link text when a linked term includes an acronym
Do not link long sentences or multiple sentences
Avoid links that pull readers away from a procedure unless the link is a p...
Files:
skills/nemo-relay-plugin-observability/references/opentelemetry.mdskills/nemo-relay-plugin-observability/references/openinference.md
**/*.{md,mdx}
📄 CodeRabbit inference engine (AGENTS.md)
Update
README.md,fern/, package READMEs, and binding-support notes when public behavior, package names, examples, or supported bindings change.
**/*.{md,mdx}: Prefer the documented public API, not internal shortcuts
Keep package names, repo references, and build commands current
Keep release-process and release-notes guidance in repo-maintainer docs such asRELEASING.md, not as user-facing docs pages orCHANGELOG.md
Keep stable user-facing wrappers atscripts/root in docs and examples; only point at namespaced helper paths when documenting internal maintenance work
When detailed dynamic plugin guides exist, keep Rust native plugin examples, Python worker plugin examples, andgrpc-v1protocol details on separate pagesIf links in documentation change, run
just docs-linkcheck.
Files:
skills/nemo-relay-plugin-observability/references/opentelemetry.mdskills/nemo-relay-plugin-observability/references/openinference.md
**/*.{md,markdown,mdx}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Add the SPDX license header to all Markdown/MDX documentation files using the HTML comment block form.
Files:
skills/nemo-relay-plugin-observability/references/opentelemetry.mdskills/nemo-relay-plugin-observability/references/openinference.md
**/*
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
**/*: Format changed files with the language-native formatter before the final lint/test pass.
If dynamic plugin behavior changed, usemaintain-dynamic-pluginsand include the native SDK, worker protocol, Python SDK, docs, packaging, and Codecov surfaces in the validation plan.
If code changes alter APIs, bindings, commands, paths, packaging behavior, observability/adaptive semantics, or documented best practices, update any dependent maintainer or consumer skills in the same branch.
During iteration, preferuv run pre-commit run --files <changed files...>.
Before review or handoff, runuv run pre-commit run --all-files.
Files:
skills/nemo-relay-plugin-observability/references/opentelemetry.mdskills/nemo-relay-plugin-observability/references/openinference.md
🔇 Additional comments (3)
skills/nemo-relay-plugin-observability/references/openinference.md (2)
13-19: LGTM!
57-61: LGTM!skills/nemo-relay-plugin-observability/references/opentelemetry.md (1)
13-22: LGTM!Also applies to: 23-63, 90-91
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)
skills/nemo-relay-plugin-observability/references/openinference.md (1)
13-19: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winFormat the setup checklist as a complete procedure.
This sequence lacks a complete lead-in sentence, terminal punctuation, and separates version selection from construction inconsistently. Use numbered imperative steps, split “construct and register” into separate actions, and punctuate each item.
🤖 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-relay-plugin-observability/references/openinference.md` around lines 13 - 19, Rewrite the setup checklist in openinference.md as numbered imperative steps with a complete introductory sentence and terminal punctuation on every item. Keep version selection paired consistently with its configuration and subscriber construction, and split subscriber construction from subscriber registration into separate steps.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.
Outside diff comments:
In `@skills/nemo-relay-plugin-observability/references/openinference.md`:
- Around line 13-19: Rewrite the setup checklist in openinference.md as numbered
imperative steps with a complete introductory sentence and terminal punctuation
on every item. Keep version selection paired consistently with its configuration
and subscriber construction, and split subscriber construction from subscriber
registration into separate steps.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Enterprise
Run ID: ffd21508-b8e7-45e7-b03d-b142053c3219
📒 Files selected for processing (1)
skills/nemo-relay-plugin-observability/references/openinference.md
📜 Review details
🧰 Additional context used
📓 Path-based instructions (8)
**/*.{md,rst,html,txt}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-brand-terminology.md)
**/*.{md,rst,html,txt}: Always spellNVIDIAin all caps. Do not useNvidia,nvidia,nVidia,nVIDIA, orNV.
Usean NVIDIAbefore a noun because the name starts with an 'en' sound.
Do not add a registered trademark symbol afterNVIDIAwhen referring to the company.
Use trademark symbols with product names only when the document type or legal guidance requires them.
Verify official capitalization, spacing, and hyphenation for product names.
Precede NVIDIA product names withNVIDIAon first mention when it is natural and accurate.
Do not rewrite product names for grammar or title-case rules.
Preserve third-party product names according to the owner's spelling.
Include the company name and full model qualifier on first use when it helps identify the model.
Preserve the official capitalization and punctuation of model names.
Use shorter family names only after the full name is established.
Spell out a term on first use and put the acronym in parentheses unless the acronym is widely understood by the intended audience.
Use the acronym on later mentions after it has been defined.
For long documents, reintroduce the full term if readers might lose context.
Form plurals of acronyms withs, not an apostrophe, such asGPUs.
In headings, common acronyms can remain abbreviated. Spell out the term in the first or second sentence of the body.
Common terms such asCPU,GPU,PC,API, andUIusually do not need to be spelled out for developer audiences.
Files:
skills/nemo-relay-plugin-observability/references/openinference.md
**/*.{md,rst,html}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-brand-terminology.md)
Link the first mention of a product name when the destination helps the reader.
Files:
skills/nemo-relay-plugin-observability/references/openinference.md
**/*.{md,rst,txt}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
Spell
NVIDIAin all caps. Do not useNvidia,nvidia, orNV.
Files:
skills/nemo-relay-plugin-observability/references/openinference.md
**/*.{md,rst}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
**/*.{md,rst}: 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 steps. Keep steps parallel and split long procedures into smaller tasks.
Prefer active voice, present tense, short sentences, contractions, and plain English.
Usecanfor possibility and reservemayfor permission.
Useafterfor temporal relationships instead ofonce.
Preferrefer tooverseewhen the wording points readers to another resource.
Avoid culture-specific idioms, unnecessary Latinisms, jokes, and marketing exaggeration in technical docs.
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 include commas in thousands.
Do not add trademark symbols to learning-oriented docs unless the source, platform, or legal guidance explicitly requires them.
Files:
skills/nemo-relay-plugin-observability/references/openinference.md
**/*.md
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-technical-docs.md)
**/*.md: Use title case consistently in technical documentation headings
Avoid quotation marks, ampersands, and exclamation marks in headings
Keep product, event, research, and whitepaper names in their official title case
Use title case for table headers
Do not force social-media sentence case into technical docs
Format code elements, commands, parameters, package names, and expressions in monospace
Format directories, file names, and paths in monospace using backticks
Use angle brackets inside monospace for variables inside paths, such as/home/<username>/.login
Format error messages and strings in quotation marks, keeping literal code strings in code formatting when clearer
Format UI buttons, menus, fields, and labels in bold
Use angle brackets between UI labels for menu paths, such as File > Save As
Use italics for new terms on first use, sparingly and only when introducing the term
Use italics for publication titles
Format keyboard shortcuts in plain text, such as Press Ctrl+Alt+Delete
Use owner/repo link text for GitHub repositories, preferring[NVIDIA/NeMo](link)over prose references like 'the GitHub repo'
Introduce every code block with a complete sentence
Do not make a code block complete the grammar of the previous sentence
Do not continue a sentence after a code block
Use syntax highlighting when the format supports it for code blocks
Avoid the word 'snippet' unless the surrounding docs already use it as a term of art
Keep inline method, function, and class references consistent with nearby docs, omitting empty parentheses for prose readability when no call is shown
Use descriptive anchor text that matches the destination title when possible for links
Avoid raw URLs in running text
Avoid generic anchor text such as 'here,' 'this page,' and 'read more'
Include acronyms in link text when a linked term includes an acronym
Do not link long sentences or multiple sentences
Avoid links that pull readers away from a procedure unless the link is a p...
Files:
skills/nemo-relay-plugin-observability/references/openinference.md
**/*.{md,mdx}
📄 CodeRabbit inference engine (AGENTS.md)
Update
README.md,fern/, package READMEs, and binding-support notes when public behavior, package names, examples, or supported bindings change.
**/*.{md,mdx}: Prefer the documented public API, not internal shortcuts
Keep package names, repo references, and build commands current
Keep release-process and release-notes guidance in repo-maintainer docs such asRELEASING.md, not as user-facing docs pages orCHANGELOG.md
Keep stable user-facing wrappers atscripts/root in docs and examples; only point at namespaced helper paths when documenting internal maintenance work
When detailed dynamic plugin guides exist, keep Rust native plugin examples, Python worker plugin examples, andgrpc-v1protocol details on separate pagesIf links in documentation change, run
just docs-linkcheck.
Files:
skills/nemo-relay-plugin-observability/references/openinference.md
**/*.{md,markdown,mdx}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Add the SPDX license header to all Markdown/MDX documentation files using the HTML comment block form.
Files:
skills/nemo-relay-plugin-observability/references/openinference.md
**/*
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
**/*: Format changed files with the language-native formatter before the final lint/test pass.
If dynamic plugin behavior changed, usemaintain-dynamic-pluginsand include the native SDK, worker protocol, Python SDK, docs, packaging, and Codecov surfaces in the validation plan.
If code changes alter APIs, bindings, commands, paths, packaging behavior, observability/adaptive semantics, or documented best practices, update any dependent maintainer or consumer skills in the same branch.
During iteration, preferuv run pre-commit run --files <changed files...>.
Before review or handoff, runuv run pre-commit run --all-files.
Files:
skills/nemo-relay-plugin-observability/references/openinference.md
🔇 Additional comments (1)
skills/nemo-relay-plugin-observability/references/openinference.md (1)
28-48: LGTM!Also applies to: 61-65
|
/ok to test f11eb2c |
|
/nvskills-ci |
1 similar comment
|
/nvskills-ci |
Signed-off-by: Will Killian <wkillian@nvidia.com>
f11eb2c to
3c71d72
Compare
|
/nvskills-ci |
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (2)
skills/nemo-relay-plugin-observability/skill-card.md (1)
1-2:⚠️ Potential issue | 🟡 MinorAdd the required SPDX header.
skill-card.mdstill starts with## Descriptionand has no HTML SPDX license comment. Add the repository-approved header before the Markdown body.As per coding guidelines, all Markdown and MDX documentation files must include an SPDX license header in HTML comment form.
🤖 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-relay-plugin-observability/skill-card.md` around lines 1 - 2, Add the repository-approved SPDX license header as an HTML comment at the beginning of skill-card.md, before the existing “## Description” content, while leaving the documentation body unchanged.Source: Coding guidelines
skills/nemo-relay-plugin-observability/evals/evals.json (1)
139-139:⚠️ Potential issue | 🟠 MajorChange the stale runtime-owner wording.
Line 139 still requires “exporter-owned runtime behavior,” contradicting Line 143 and
references/opentelemetry.md, which state that the 0.7 subscriber owns the Tokio runtime. Change the oracle to “subscriber-owned runtime behavior.”🤖 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-relay-plugin-observability/evals/evals.json` at line 139, Update the ground_truth text in the evaluation entry to replace “exporter-owned runtime behavior” with “subscriber-owned runtime behavior,” keeping the remaining guidance unchanged and aligned with the 0.7 subscriber runtime ownership.
🤖 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-relay-plugin-observability/references/openinference.md`:
- Around line 13-21: Add a complete lead-in sentence immediately before the
Default Path bullet list in both
skills/nemo-relay-plugin-observability/references/openinference.md (lines 13-21)
and skills/nemo-relay-plugin-observability/references/opentelemetry.md (lines
13-21). Ensure each sentence introduces its version-specific setup steps and
preserves the existing parallel, punctuated list structure.
---
Duplicate comments:
In `@skills/nemo-relay-plugin-observability/evals/evals.json`:
- Line 139: Update the ground_truth text in the evaluation entry to replace
“exporter-owned runtime behavior” with “subscriber-owned runtime behavior,”
keeping the remaining guidance unchanged and aligned with the 0.7 subscriber
runtime ownership.
In `@skills/nemo-relay-plugin-observability/skill-card.md`:
- Around line 1-2: Add the repository-approved SPDX license header as an HTML
comment at the beginning of skill-card.md, before the existing “## Description”
content, while leaving the documentation body 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: 556a1ae0-206a-4bff-b628-6ada0bb24b83
📒 Files selected for processing (9)
skills/README.mdskills/nemo-relay-debug-runtime-integration/SKILL.mdskills/nemo-relay-get-started/references/cli-try-now.mdskills/nemo-relay-plugin-observability/SKILL.mdskills/nemo-relay-plugin-observability/evals/evals.jsonskills/nemo-relay-plugin-observability/references/atof.mdskills/nemo-relay-plugin-observability/references/openinference.mdskills/nemo-relay-plugin-observability/references/opentelemetry.mdskills/nemo-relay-plugin-observability/skill-card.md
📜 Review details
🧰 Additional context used
📓 Path-based instructions (9)
**/*.{md,rst,html,txt}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-brand-terminology.md)
**/*.{md,rst,html,txt}: Always spellNVIDIAin all caps. Do not useNvidia,nvidia,nVidia,nVIDIA, orNV.
Usean NVIDIAbefore a noun because the name starts with an 'en' sound.
Do not add a registered trademark symbol afterNVIDIAwhen referring to the company.
Use trademark symbols with product names only when the document type or legal guidance requires them.
Verify official capitalization, spacing, and hyphenation for product names.
Precede NVIDIA product names withNVIDIAon first mention when it is natural and accurate.
Do not rewrite product names for grammar or title-case rules.
Preserve third-party product names according to the owner's spelling.
Include the company name and full model qualifier on first use when it helps identify the model.
Preserve the official capitalization and punctuation of model names.
Use shorter family names only after the full name is established.
Spell out a term on first use and put the acronym in parentheses unless the acronym is widely understood by the intended audience.
Use the acronym on later mentions after it has been defined.
For long documents, reintroduce the full term if readers might lose context.
Form plurals of acronyms withs, not an apostrophe, such asGPUs.
In headings, common acronyms can remain abbreviated. Spell out the term in the first or second sentence of the body.
Common terms such asCPU,GPU,PC,API, andUIusually do not need to be spelled out for developer audiences.
Files:
skills/nemo-relay-get-started/references/cli-try-now.mdskills/nemo-relay-plugin-observability/references/atof.mdskills/nemo-relay-debug-runtime-integration/SKILL.mdskills/README.mdskills/nemo-relay-plugin-observability/skill-card.mdskills/nemo-relay-plugin-observability/references/opentelemetry.mdskills/nemo-relay-plugin-observability/references/openinference.mdskills/nemo-relay-plugin-observability/SKILL.md
**/*.{md,rst,html}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-brand-terminology.md)
Link the first mention of a product name when the destination helps the reader.
Files:
skills/nemo-relay-get-started/references/cli-try-now.mdskills/nemo-relay-plugin-observability/references/atof.mdskills/nemo-relay-debug-runtime-integration/SKILL.mdskills/README.mdskills/nemo-relay-plugin-observability/skill-card.mdskills/nemo-relay-plugin-observability/references/opentelemetry.mdskills/nemo-relay-plugin-observability/references/openinference.mdskills/nemo-relay-plugin-observability/SKILL.md
**/*.{md,rst,txt}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
Spell
NVIDIAin all caps. Do not useNvidia,nvidia, orNV.
Files:
skills/nemo-relay-get-started/references/cli-try-now.mdskills/nemo-relay-plugin-observability/references/atof.mdskills/nemo-relay-debug-runtime-integration/SKILL.mdskills/README.mdskills/nemo-relay-plugin-observability/skill-card.mdskills/nemo-relay-plugin-observability/references/opentelemetry.mdskills/nemo-relay-plugin-observability/references/openinference.mdskills/nemo-relay-plugin-observability/SKILL.md
**/*.{md,rst}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
**/*.{md,rst}: 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 steps. Keep steps parallel and split long procedures into smaller tasks.
Prefer active voice, present tense, short sentences, contractions, and plain English.
Usecanfor possibility and reservemayfor permission.
Useafterfor temporal relationships instead ofonce.
Preferrefer tooverseewhen the wording points readers to another resource.
Avoid culture-specific idioms, unnecessary Latinisms, jokes, and marketing exaggeration in technical docs.
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 include commas in thousands.
Do not add trademark symbols to learning-oriented docs unless the source, platform, or legal guidance explicitly requires them.
Files:
skills/nemo-relay-get-started/references/cli-try-now.mdskills/nemo-relay-plugin-observability/references/atof.mdskills/nemo-relay-debug-runtime-integration/SKILL.mdskills/README.mdskills/nemo-relay-plugin-observability/skill-card.mdskills/nemo-relay-plugin-observability/references/opentelemetry.mdskills/nemo-relay-plugin-observability/references/openinference.mdskills/nemo-relay-plugin-observability/SKILL.md
**/*.md
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-technical-docs.md)
**/*.md: Use title case consistently in technical documentation headings
Avoid quotation marks, ampersands, and exclamation marks in headings
Keep product, event, research, and whitepaper names in their official title case
Use title case for table headers
Do not force social-media sentence case into technical docs
Format code elements, commands, parameters, package names, and expressions in monospace
Format directories, file names, and paths in monospace using backticks
Use angle brackets inside monospace for variables inside paths, such as/home/<username>/.login
Format error messages and strings in quotation marks, keeping literal code strings in code formatting when clearer
Format UI buttons, menus, fields, and labels in bold
Use angle brackets between UI labels for menu paths, such as File > Save As
Use italics for new terms on first use, sparingly and only when introducing the term
Use italics for publication titles
Format keyboard shortcuts in plain text, such as Press Ctrl+Alt+Delete
Use owner/repo link text for GitHub repositories, preferring[NVIDIA/NeMo](link)over prose references like 'the GitHub repo'
Introduce every code block with a complete sentence
Do not make a code block complete the grammar of the previous sentence
Do not continue a sentence after a code block
Use syntax highlighting when the format supports it for code blocks
Avoid the word 'snippet' unless the surrounding docs already use it as a term of art
Keep inline method, function, and class references consistent with nearby docs, omitting empty parentheses for prose readability when no call is shown
Use descriptive anchor text that matches the destination title when possible for links
Avoid raw URLs in running text
Avoid generic anchor text such as 'here,' 'this page,' and 'read more'
Include acronyms in link text when a linked term includes an acronym
Do not link long sentences or multiple sentences
Avoid links that pull readers away from a procedure unless the link is a p...
Files:
skills/nemo-relay-get-started/references/cli-try-now.mdskills/nemo-relay-plugin-observability/references/atof.mdskills/nemo-relay-debug-runtime-integration/SKILL.mdskills/README.mdskills/nemo-relay-plugin-observability/skill-card.mdskills/nemo-relay-plugin-observability/references/opentelemetry.mdskills/nemo-relay-plugin-observability/references/openinference.mdskills/nemo-relay-plugin-observability/SKILL.md
**/*.{md,mdx}
📄 CodeRabbit inference engine (AGENTS.md)
Update
README.md,fern/, package READMEs, and binding-support notes when public behavior, package names, examples, or supported bindings change.
**/*.{md,mdx}: Prefer the documented public API, not internal shortcuts
Keep package names, repo references, and build commands current
Keep release-process and release-notes guidance in repo-maintainer docs such asRELEASING.md, not as user-facing docs pages orCHANGELOG.md
Keep stable user-facing wrappers atscripts/root in docs and examples; only point at namespaced helper paths when documenting internal maintenance work
When detailed dynamic plugin guides exist, keep Rust native plugin examples, Python worker plugin examples, andgrpc-v1protocol details on separate pagesIf links in documentation change, run
just docs-linkcheck.
Files:
skills/nemo-relay-get-started/references/cli-try-now.mdskills/nemo-relay-plugin-observability/references/atof.mdskills/nemo-relay-debug-runtime-integration/SKILL.mdskills/README.mdskills/nemo-relay-plugin-observability/skill-card.mdskills/nemo-relay-plugin-observability/references/opentelemetry.mdskills/nemo-relay-plugin-observability/references/openinference.mdskills/nemo-relay-plugin-observability/SKILL.md
**/*.{md,markdown,mdx}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Add the SPDX license header to all Markdown/MDX documentation files using the HTML comment block form.
Files:
skills/nemo-relay-get-started/references/cli-try-now.mdskills/nemo-relay-plugin-observability/references/atof.mdskills/nemo-relay-debug-runtime-integration/SKILL.mdskills/README.mdskills/nemo-relay-plugin-observability/skill-card.mdskills/nemo-relay-plugin-observability/references/opentelemetry.mdskills/nemo-relay-plugin-observability/references/openinference.mdskills/nemo-relay-plugin-observability/SKILL.md
**/*
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
**/*: Format changed files with the language-native formatter before the final lint/test pass.
If dynamic plugin behavior changed, usemaintain-dynamic-pluginsand include the native SDK, worker protocol, Python SDK, docs, packaging, and Codecov surfaces in the validation plan.
If code changes alter APIs, bindings, commands, paths, packaging behavior, observability/adaptive semantics, or documented best practices, update any dependent maintainer or consumer skills in the same branch.
During iteration, preferuv run pre-commit run --files <changed files...>.
Before review or handoff, runuv run pre-commit run --all-files.
Files:
skills/nemo-relay-get-started/references/cli-try-now.mdskills/nemo-relay-plugin-observability/references/atof.mdskills/nemo-relay-debug-runtime-integration/SKILL.mdskills/README.mdskills/nemo-relay-plugin-observability/skill-card.mdskills/nemo-relay-plugin-observability/references/opentelemetry.mdskills/nemo-relay-plugin-observability/references/openinference.mdskills/nemo-relay-plugin-observability/SKILL.mdskills/nemo-relay-plugin-observability/evals/evals.json
**/SKILL.md
📄 CodeRabbit inference engine (AGENTS.md)
SKILL.mdfiles are skill entrypoints and must start with YAML frontmatter containing at leastnameanddescription.
Files:
skills/nemo-relay-debug-runtime-integration/SKILL.mdskills/nemo-relay-plugin-observability/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-relay-debug-runtime-integration/SKILL.mdskills/nemo-relay-plugin-observability/SKILL.md
🪛 LanguageTool
skills/nemo-relay-plugin-observability/SKILL.md
[style] ~121-~121: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ry.mdfor OTLP/OpenTelemetry traces. - Loadreferences/openinference.md` for the s...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🔇 Additional comments (8)
skills/nemo-relay-plugin-observability/SKILL.md (2)
20-33: LGTM!Also applies to: 44-48, 71-71, 97-108, 121-122
3-3: 📐 Maintainability & Code QualityVerify the required
SKILL.mdfrontmatter.
skills/nemo-relay-plugin-observability/SKILL.md#L3-L3: inspect the omitted file start and confirm YAML frontmatter withnameanddescription.skills/nemo-relay-debug-runtime-integration/SKILL.md#L67-L71: inspect the omitted file start and confirm YAML frontmatter withnameanddescription.As per path instructions,
SKILL.mdfiles must keep valid YAML frontmatter with at leastnameanddescriptionfields, and are not flagged for missing SPDX headers.Source: Path instructions
skills/README.md (1)
68-68: LGTM!skills/nemo-relay-get-started/references/cli-try-now.md (1)
105-107: LGTM!Also applies to: 117-117
skills/nemo-relay-plugin-observability/references/atof.md (1)
15-17: LGTM!Also applies to: 27-27
skills/nemo-relay-plugin-observability/references/openinference.md (1)
28-48: LGTM!Also applies to: 61-65
skills/nemo-relay-plugin-observability/references/opentelemetry.md (1)
25-63: LGTM!Also applies to: 90-91
skills/nemo-relay-plugin-observability/evals/evals.json (1)
7-13: LGTM!Also applies to: 23-29, 120-127, 182-207, 216-221, 248-248
|
/nvskills-ci |
Signed-off-by: nvskills-svc-account <svc-nvskills-signing@nvidia.com>
|
/ok to test 6fbeb82 |
bbednarski9
left a comment
bbednarski9
left a comment
There was a problem hiding this comment.
Some comments above lmk when ready to re-review
Signed-off-by: Will Killian <wkillian@nvidia.com>
|
/ok to test 3d73477 |
|
/ok to test f23d697 |
|
Looks like the skill artifacts were generated before the final projection-clarification edits. At the current head, skill.oms.sig still has the older digests for evals.json, openinference.md, and opentelemetry.md, but those files changed afterward. Can we rerun the NVSkills generation/signing step from the final content so BENCHMARK.md, skill-card.md, and skill.oms.sig line up again? Also the evals.json oracle should say subscriber-owned runtime behavior, not exporter-owned, to match the 0.7 docs. |
mnajafian-nv
left a comment
mnajafian-nv
left a comment
There was a problem hiding this comment.
LGTM, pending your review of 2 suggestions made.
|
@mnajafian-nv i was waiting for approval before re-triggering |
|
/nvskills-ci |
Signed-off-by: nvskills-svc-account <svc-nvskills-signing@nvidia.com>
|
/ok to test ff7cdcd |
5 participants
Overview
Updates the public observability skills to support both NeMo Relay 0.6 and 0.7. The skills now establish the installed Relay version before selecting configuration or binding APIs, preserving the 0.6 standalone OpenTelemetry/OpenInference surfaces while documenting the typed OpenTelemetry endpoint model introduced for 0.7 by #556.
Details
OpenTelemetryConfig/OpenTelemetrySubscriberandOpenInferenceConfig/OpenInferenceSubscriberguidance.OpenTelemetryConfig/OpenTelemetrySubscribermodel withfull,gen_ai, andopeninferenceprojections.Where should the reviewer start?
Start with
skills/nemo-relay-plugin-observability/SKILL.md, especially Select The Relay Version, then reviewskills/nemo-relay-plugin-observability/references/opentelemetry.mdandskills/nemo-relay-plugin-observability/references/openinference.mdfor the version-specific API and semantic split.Validation performed on commit
f8590edd7:All targeted hooks passed, including JSON validation and documentation link checking. A full
pre-commit --all-filesrun passed all code, formatting, lint, type, link, and lockfile checks; its Rust attribution hook regenerated an unrelated attribution file, which was intentionally excluded from this skills-only change.Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)
Summary by CodeRabbit