docs(skills): harden observability export and validate batch 2#423
Conversation
Make trivial wording-only updates to four public Relay skills so the NVCARPS/NVSkills CI pipeline can validate the next controlled batch. Validation: uv run pre-commit run --files skills/nemo-relay-instrument-calls/SKILL.md skills/nemo-relay-instrument-context-isolation/SKILL.md skills/nemo-relay-instrument-typed-wrappers/SKILL.md skills/nemo-relay-plugin-observability/SKILL.md Signed-off-by: Allan Enemark <exactly.allan@gmail.com>
github-actions
Bot
added
size:XS
|
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:
WalkthroughFour Relay skills gain behavioral guidance, benchmark reports, skill cards, and DSSE signatures. Observability guidance and evaluation criteria add proof-selection, sanitization, runtime credential, TLS, and redacted-diagnostic requirements. ChangesRelay skill guidance and publication artifacts
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
/okay to test dd517dd |
|
/nvskills-ci |
Signed-off-by: nvskills-svc-account <svc-nvskills-signing@nvidia.com>
github-actions
Bot
added
size:L
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 13
🤖 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-instrument-calls/BENCHMARK.md`:
- Around line 18-21: Add complete introductory sentences before each bare list:
the agents list in skills/nemo-relay-instrument-calls/BENCHMARK.md (18-21),
references and evaluation-agent lists in
skills/nemo-relay-instrument-calls/skill-card.md (27-28, 37-39), the agents list
in skills/nemo-relay-instrument-context-isolation/BENCHMARK.md (18-21), and
references and evaluation-agent lists in
skills/nemo-relay-plugin-observability/skill-card.md (27-31, 40-42).
- Line 1: Add the repository-standard SPDX license header in HTML comment form
at the beginning of each affected Markdown file:
skills/nemo-relay-instrument-calls/BENCHMARK.md (lines 1-1),
skills/nemo-relay-instrument-calls/skill-card.md (lines 1-1),
skills/nemo-relay-instrument-context-isolation/BENCHMARK.md (lines 1-1), and
skills/nemo-relay-plugin-observability/skill-card.md (lines 1-1). Place the
header before the existing content, including each “# Evaluation Report” heading
or card content.
- Line 48: Correct the benchmark count grammar by changing “1 tasks” to “1 task”
and “1 checks” to “1 check” in skills/nemo-relay-instrument-calls/BENCHMARK.md
at lines 48 and 67, and apply the same corrections in
skills/nemo-relay-instrument-context-isolation/BENCHMARK.md at lines 48 and 67.
In `@skills/nemo-relay-instrument-calls/skill-card.md`:
- Line 81: Replace the generic “here” anchor with descriptive destination text
for the NVIDIA AI Concerns reporting link in
skills/nemo-relay-instrument-calls/skill-card.md at lines 81-81 and
skills/nemo-relay-plugin-observability/skill-card.md at lines 84-84, keeping
both links pointed to their existing destinations.
- Line 2: Make product and repository references consistent: in
skills/nemo-relay-instrument-calls/skill-card.md lines 2-2, change the first
mention to linked “NVIDIA NeMo Relay”; at lines 28-28, use owner/repository link
text such as “NVIDIA/NeMo-Relay”; and in
skills/nemo-relay-plugin-observability/skill-card.md lines 2-2, change the first
mention to linked “NVIDIA NeMo Relay”.
- Around line 1-2: Keep the existing ## Description-first schema without adding
a top-level title at skills/nemo-relay-instrument-calls/skill-card.md lines 1-2
or skills/nemo-relay-plugin-observability/skill-card.md lines 1-2. At the
Evaluation Results tables in skills/nemo-relay-instrument-calls/skill-card.md
lines 65-66 and skills/nemo-relay-plugin-observability/skill-card.md lines
68-69, add a blank line before each table and a brief lead-in sentence.
In `@skills/nemo-relay-instrument-context-isolation/skill-card.md`:
- Line 82: Replace the generic “[here]” link text with descriptive
reporting-link anchor text in
skills/nemo-relay-instrument-context-isolation/skill-card.md:82 and
skills/nemo-relay-instrument-typed-wrappers/skill-card.md:81, preserving the
existing URLs. Run just docs-linkcheck after updating both cards.
- Line 2: The first “NeMo Relay” product mention in
skills/nemo-relay-instrument-context-isolation/skill-card.md lines 2-2 must link
to the relevant destination. Apply the same first-mention link to “NeMo Relay”
in skills/nemo-relay-instrument-typed-wrappers/skill-card.md lines 2-2,
preserving the surrounding text.
- Around line 1-17: Normalize the Markdown structure in
skills/nemo-relay-instrument-context-isolation/skill-card.md lines 1-17 by
adding a top-level heading and required blank lines around headings and the
results table, or document an explicit markdownlint exemption for this generated
layout. Apply the same change or exemption to
skills/nemo-relay-instrument-typed-wrappers/skill-card.md lines 1-17, addressing
MD041, MD022, and MD058 without altering the skill content.
- Line 1: Add the repository-standard SPDX HTML comment before the title in
skills/nemo-relay-instrument-context-isolation/skill-card.md,
skills/nemo-relay-instrument-typed-wrappers/BENCHMARK.md,
skills/nemo-relay-instrument-typed-wrappers/skill-card.md, and
skills/nemo-relay-plugin-observability/BENCHMARK.md, then regenerate each file’s
corresponding signature.
In `@skills/nemo-relay-instrument-typed-wrappers/BENCHMARK.md`:
- Line 48: Correct the singular benchmark wording: update “1 tasks” to “1 task”
in skills/nemo-relay-instrument-typed-wrappers/BENCHMARK.md at lines 48-48, and
update “1 checks” to “1 check” at lines 67-67 in both
skills/nemo-relay-instrument-typed-wrappers/BENCHMARK.md and
skills/nemo-relay-plugin-observability/BENCHMARK.md.
- Around line 3-5: Align the evaluation summaries with their documented scope in
skills/nemo-relay-instrument-typed-wrappers/BENCHMARK.md lines 3-5 and
skills/nemo-relay-plugin-observability/BENCHMARK.md lines 3-5: either add the
missing Tier 3 evaluation section to both reports or change each “3-Tier
Evaluation” summary to accurately describe the existing Tier 1 and Tier 2
content.
In `@skills/nemo-relay-plugin-observability/skill-card.md`:
- Line 47: Clarify the meaning of the Num column in the evaluation summary and
reconcile it with the reported 20-task total and the rows showing Num = 8.
Update the table or summary so the task counts consistently reflect the same
defined measure.
🪄 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: d2b172ab-79bd-4563-86e1-ad8fbd7513b2
📒 Files selected for processing (12)
skills/nemo-relay-instrument-calls/BENCHMARK.mdskills/nemo-relay-instrument-calls/skill-card.mdskills/nemo-relay-instrument-calls/skill.oms.sigskills/nemo-relay-instrument-context-isolation/BENCHMARK.mdskills/nemo-relay-instrument-context-isolation/skill-card.mdskills/nemo-relay-instrument-context-isolation/skill.oms.sigskills/nemo-relay-instrument-typed-wrappers/BENCHMARK.mdskills/nemo-relay-instrument-typed-wrappers/skill-card.mdskills/nemo-relay-instrument-typed-wrappers/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)
**/*.{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-instrument-context-isolation/BENCHMARK.mdskills/nemo-relay-instrument-calls/BENCHMARK.mdskills/nemo-relay-instrument-typed-wrappers/BENCHMARK.mdskills/nemo-relay-instrument-context-isolation/skill-card.mdskills/nemo-relay-instrument-typed-wrappers/skill-card.mdskills/nemo-relay-plugin-observability/BENCHMARK.mdskills/nemo-relay-instrument-calls/skill-card.mdskills/nemo-relay-plugin-observability/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-instrument-context-isolation/BENCHMARK.mdskills/nemo-relay-instrument-calls/BENCHMARK.mdskills/nemo-relay-instrument-typed-wrappers/BENCHMARK.mdskills/nemo-relay-instrument-context-isolation/skill-card.mdskills/nemo-relay-instrument-typed-wrappers/skill-card.mdskills/nemo-relay-plugin-observability/BENCHMARK.mdskills/nemo-relay-instrument-calls/skill-card.mdskills/nemo-relay-plugin-observability/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-instrument-context-isolation/BENCHMARK.mdskills/nemo-relay-instrument-calls/BENCHMARK.mdskills/nemo-relay-instrument-typed-wrappers/BENCHMARK.mdskills/nemo-relay-instrument-context-isolation/skill-card.mdskills/nemo-relay-instrument-typed-wrappers/skill-card.mdskills/nemo-relay-plugin-observability/BENCHMARK.mdskills/nemo-relay-instrument-calls/skill-card.mdskills/nemo-relay-plugin-observability/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-instrument-context-isolation/BENCHMARK.mdskills/nemo-relay-instrument-calls/BENCHMARK.mdskills/nemo-relay-instrument-typed-wrappers/BENCHMARK.mdskills/nemo-relay-instrument-context-isolation/skill-card.mdskills/nemo-relay-instrument-typed-wrappers/skill-card.mdskills/nemo-relay-plugin-observability/BENCHMARK.mdskills/nemo-relay-instrument-calls/skill-card.mdskills/nemo-relay-plugin-observability/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-instrument-context-isolation/BENCHMARK.mdskills/nemo-relay-instrument-calls/BENCHMARK.mdskills/nemo-relay-instrument-typed-wrappers/BENCHMARK.mdskills/nemo-relay-instrument-context-isolation/skill-card.mdskills/nemo-relay-instrument-typed-wrappers/skill-card.mdskills/nemo-relay-plugin-observability/BENCHMARK.mdskills/nemo-relay-instrument-calls/skill-card.mdskills/nemo-relay-plugin-observability/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-instrument-context-isolation/BENCHMARK.mdskills/nemo-relay-instrument-calls/BENCHMARK.mdskills/nemo-relay-instrument-typed-wrappers/BENCHMARK.mdskills/nemo-relay-instrument-context-isolation/skill-card.mdskills/nemo-relay-instrument-typed-wrappers/skill-card.mdskills/nemo-relay-plugin-observability/BENCHMARK.mdskills/nemo-relay-instrument-calls/skill-card.mdskills/nemo-relay-plugin-observability/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-instrument-context-isolation/BENCHMARK.mdskills/nemo-relay-instrument-calls/BENCHMARK.mdskills/nemo-relay-instrument-typed-wrappers/BENCHMARK.mdskills/nemo-relay-instrument-context-isolation/skill-card.mdskills/nemo-relay-instrument-typed-wrappers/skill-card.mdskills/nemo-relay-plugin-observability/BENCHMARK.mdskills/nemo-relay-instrument-calls/skill-card.mdskills/nemo-relay-plugin-observability/skill-card.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-instrument-context-isolation/BENCHMARK.mdskills/nemo-relay-instrument-calls/BENCHMARK.mdskills/nemo-relay-instrument-typed-wrappers/BENCHMARK.mdskills/nemo-relay-instrument-context-isolation/skill-card.mdskills/nemo-relay-instrument-typed-wrappers/skill-card.mdskills/nemo-relay-plugin-observability/BENCHMARK.mdskills/nemo-relay-instrument-calls/skill.oms.sigskills/nemo-relay-instrument-context-isolation/skill.oms.sigskills/nemo-relay-instrument-calls/skill-card.mdskills/nemo-relay-plugin-observability/skill.oms.sigskills/nemo-relay-plugin-observability/skill-card.mdskills/nemo-relay-instrument-typed-wrappers/skill.oms.sig
🪛 markdownlint-cli2 (0.23.0)
skills/nemo-relay-instrument-context-isolation/skill-card.md
[warning] 1-1: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 1-1: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
[warning] 6-6: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 9-9: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 11-11: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above
(MD022, blanks-around-headings)
[warning] 11-11: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[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] 23-23: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 27-27: 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] 66-66: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 67-67: 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)
[warning] 78-78: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 82-82: Link text should be descriptive
(MD059, descriptive-link-text)
skills/nemo-relay-instrument-typed-wrappers/skill-card.md
[warning] 1-1: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 1-1: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
[warning] 6-6: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 9-9: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 11-11: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above
(MD022, blanks-around-headings)
[warning] 11-11: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[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] 23-23: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 27-27: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 31-31: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 37-37: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 43-43: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 46-46: 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] 74-74: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 77-77: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 81-81: Link text should be descriptive
(MD059, descriptive-link-text)
skills/nemo-relay-instrument-calls/skill-card.md
[warning] 1-1: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 1-1: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
[warning] 6-6: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 9-9: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 11-11: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above
(MD022, blanks-around-headings)
[warning] 11-11: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[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] 23-23: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 27-27: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 31-31: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 37-37: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 43-43: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 46-46: 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] 74-74: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 77-77: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 81-81: Link text should be descriptive
(MD059, descriptive-link-text)
skills/nemo-relay-plugin-observability/skill-card.md
[warning] 1-1: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 1-1: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
[warning] 6-6: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 9-9: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 11-11: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above
(MD022, blanks-around-headings)
[warning] 11-11: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[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] 23-23: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 27-27: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 34-34: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 40-40: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 46-46: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 49-49: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 68-68: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 69-69: 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)
[warning] 80-80: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 84-84: Link text should be descriptive
(MD059, descriptive-link-text)
🔇 Additional comments (3)
skills/nemo-relay-instrument-calls/skill.oms.sig (1)
1-1: 🔒 Security & PrivacyVerify both signature bundles against final publication inputs.
Confirm exact subject digests and signer validation for all referenced files. Also verify whether the publication policy permits empty
tlogEntries; otherwise regenerate both bundles with transparency-log evidence.
skills/nemo-relay-instrument-calls/skill.oms.sig#L1-L1: verify the signed calls-skill resources.skills/nemo-relay-plugin-observability/skill.oms.sig#L1-L1: verify the signed observability-skill resources.skills/nemo-relay-instrument-context-isolation/skill.oms.sig (1)
1-1: 🔒 Security & PrivacyVerify the empty transparency-log policy for both bundles.
skills/nemo-relay-instrument-context-isolation/skill.oms.sig#L1-L1: confirm the verifier acceptstlogEntries: []without a trusted timestamp.skills/nemo-relay-instrument-typed-wrappers/skill.oms.sig#L1-L1: confirm the same trust policy for this bundle.If transparency-log or timestamp evidence is required, regenerate these signatures with the required provenance material.
skills/nemo-relay-plugin-observability/BENCHMARK.md (1)
45-61: 🎯 Functional CorrectnessReconcile the task count and results denominator.
The report states that the dataset contains 20 tasks, but every results row reports
Numas 8. Define whatNummeasures or correct the denominator so readers can reproduce the benchmark results.The supplied benchmark report contains this unresolved count discrepancy.
Require synthetic first-run payloads, runtime-only credential injection, TLS verification, and redacted OTLP troubleshooting guidance. Validation: UV_CACHE_DIR=/tmp/uv-cache uv run pre-commit run --files skills/nemo-relay-plugin-observability/SKILL.md skills/nemo-relay-plugin-observability/references/opentelemetry.md skills/nemo-relay-plugin-observability/evals/evals.json Signed-off-by: Allan Enemark <exactly.allan@gmail.com>
exactlyallan
changed the title
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@skills/nemo-relay-plugin-observability/evals/evals.json`:
- Around line 136-142: Extend the OpenTelemetry evaluation in the ground_truth
and expected_behavior entries to require synthetic first-proof payloads,
sanitization before production export, and backend-span validation with redacted
diagnostics. Ensure the assertions reference the sanitization and
exporter-validation guidance from SKILL.md and references/opentelemetry.md while
preserving the existing runtime-only credential and TLS requirements.
🪄 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: d7466c5c-0067-4ffa-be2a-831c6870d3c5
📒 Files selected for processing (3)
skills/nemo-relay-plugin-observability/SKILL.mdskills/nemo-relay-plugin-observability/evals/evals.jsonskills/nemo-relay-plugin-observability/references/opentelemetry.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-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-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-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-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-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-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-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-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-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-plugin-observability/SKILL.mdskills/nemo-relay-plugin-observability/evals/evals.jsonskills/nemo-relay-plugin-observability/references/opentelemetry.md
🔇 Additional comments (4)
skills/nemo-relay-plugin-observability/SKILL.md (2)
35-39: LGTM!
14-14: No issue:skills/nemo-relay-plugin-observability/SKILL.mdalready has valid YAML frontmatter withnameanddescription.> Likely an incorrect or invalid review comment.skills/nemo-relay-plugin-observability/references/opentelemetry.md (2)
29-56: LGTM!
14-15: SPDX Header Is Present
skills/nemo-relay-plugin-observability/references/opentelemetry.mdalready includes the required SPDX HTML comment block at the top; no change needed.> Likely an incorrect or invalid review comment.
Require synthetic first-proof telemetry, sanitization before production export, backend span checks, and redacted diagnostics in the OpenTelemetry evaluation contract. Signed-off-by: Allan Enemark <exactly.allan@gmail.com>
|
/nvskills-ci |
Signed-off-by: nvskills-svc-account <svc-nvskills-signing@nvidia.com>
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/skill-card.md`:
- Around line 17-21: Update the Requirements / Dependencies metadata in the
skill card to identify OpenTelemetry/OpenInference exporter credentials as
backend-dependent rather than unspecified or absent. Keep credential values out
of source, prompts, logs, and examples, and retain the existing least-privilege
and rotation guidance.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Enterprise
Run ID: 676fdd78-6119-4cdf-b311-4a6b5277338b
📒 Files selected for processing (12)
skills/nemo-relay-instrument-calls/BENCHMARK.mdskills/nemo-relay-instrument-calls/skill-card.mdskills/nemo-relay-instrument-calls/skill.oms.sigskills/nemo-relay-instrument-context-isolation/BENCHMARK.mdskills/nemo-relay-instrument-context-isolation/skill-card.mdskills/nemo-relay-instrument-context-isolation/skill.oms.sigskills/nemo-relay-instrument-typed-wrappers/BENCHMARK.mdskills/nemo-relay-instrument-typed-wrappers/skill-card.mdskills/nemo-relay-instrument-typed-wrappers/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-plugin-observability/BENCHMARK.mdskills/nemo-relay-instrument-context-isolation/BENCHMARK.mdskills/nemo-relay-instrument-calls/skill.oms.sigskills/nemo-relay-instrument-context-isolation/skill.oms.sigskills/nemo-relay-instrument-typed-wrappers/BENCHMARK.mdskills/nemo-relay-instrument-typed-wrappers/skill.oms.sigskills/nemo-relay-instrument-calls/BENCHMARK.mdskills/nemo-relay-instrument-typed-wrappers/skill-card.mdskills/nemo-relay-instrument-calls/skill-card.mdskills/nemo-relay-instrument-context-isolation/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-instrument-context-isolation/BENCHMARK.mdskills/nemo-relay-instrument-typed-wrappers/BENCHMARK.mdskills/nemo-relay-instrument-calls/BENCHMARK.mdskills/nemo-relay-instrument-typed-wrappers/skill-card.mdskills/nemo-relay-instrument-calls/skill-card.mdskills/nemo-relay-instrument-context-isolation/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-instrument-context-isolation/BENCHMARK.mdskills/nemo-relay-instrument-typed-wrappers/BENCHMARK.mdskills/nemo-relay-instrument-calls/BENCHMARK.mdskills/nemo-relay-instrument-typed-wrappers/skill-card.mdskills/nemo-relay-instrument-calls/skill-card.mdskills/nemo-relay-instrument-context-isolation/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-instrument-context-isolation/BENCHMARK.mdskills/nemo-relay-instrument-typed-wrappers/BENCHMARK.mdskills/nemo-relay-instrument-calls/BENCHMARK.mdskills/nemo-relay-instrument-typed-wrappers/skill-card.mdskills/nemo-relay-instrument-calls/skill-card.mdskills/nemo-relay-instrument-context-isolation/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-instrument-context-isolation/BENCHMARK.mdskills/nemo-relay-instrument-typed-wrappers/BENCHMARK.mdskills/nemo-relay-instrument-calls/BENCHMARK.mdskills/nemo-relay-instrument-typed-wrappers/skill-card.mdskills/nemo-relay-instrument-calls/skill-card.mdskills/nemo-relay-instrument-context-isolation/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-instrument-context-isolation/BENCHMARK.mdskills/nemo-relay-instrument-typed-wrappers/BENCHMARK.mdskills/nemo-relay-instrument-calls/BENCHMARK.mdskills/nemo-relay-instrument-typed-wrappers/skill-card.mdskills/nemo-relay-instrument-calls/skill-card.mdskills/nemo-relay-instrument-context-isolation/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-instrument-context-isolation/BENCHMARK.mdskills/nemo-relay-instrument-typed-wrappers/BENCHMARK.mdskills/nemo-relay-instrument-calls/BENCHMARK.mdskills/nemo-relay-instrument-typed-wrappers/skill-card.mdskills/nemo-relay-instrument-calls/skill-card.mdskills/nemo-relay-instrument-context-isolation/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-instrument-context-isolation/BENCHMARK.mdskills/nemo-relay-instrument-typed-wrappers/BENCHMARK.mdskills/nemo-relay-instrument-calls/BENCHMARK.mdskills/nemo-relay-instrument-typed-wrappers/skill-card.mdskills/nemo-relay-instrument-calls/skill-card.mdskills/nemo-relay-instrument-context-isolation/skill-card.md
🪛 markdownlint-cli2 (0.23.0)
skills/nemo-relay-plugin-observability/skill-card.md
[warning] 1-1: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 1-1: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
[warning] 6-6: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 9-9: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 11-11: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above
(MD022, blanks-around-headings)
[warning] 11-11: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[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] 23-23: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 27-27: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 34-34: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 40-40: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 46-46: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 49-49: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 68-68: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 69-69: 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)
[warning] 80-80: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 84-84: Link text should be descriptive
(MD059, descriptive-link-text)
skills/nemo-relay-instrument-typed-wrappers/skill-card.md
[warning] 1-1: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 1-1: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
[warning] 6-6: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 9-9: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 11-11: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above
(MD022, blanks-around-headings)
[warning] 11-11: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[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] 23-23: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 27-27: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 31-31: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 37-37: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 43-43: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 46-46: 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] 74-74: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 77-77: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 81-81: Link text should be descriptive
(MD059, descriptive-link-text)
skills/nemo-relay-instrument-calls/skill-card.md
[warning] 1-1: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 1-1: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
[warning] 6-6: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 9-9: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 11-11: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above
(MD022, blanks-around-headings)
[warning] 11-11: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[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] 23-23: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 27-27: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 31-31: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 37-37: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 43-43: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 46-46: 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] 74-74: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 77-77: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 81-81: Link text should be descriptive
(MD059, descriptive-link-text)
skills/nemo-relay-instrument-context-isolation/skill-card.md
[warning] 1-1: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 1-1: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
[warning] 6-6: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 9-9: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 11-11: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above
(MD022, blanks-around-headings)
[warning] 11-11: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[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] 23-23: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 27-27: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 31-31: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 37-37: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 43-43: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 46-46: 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] 74-74: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 77-77: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 81-81: Link text should be descriptive
(MD059, descriptive-link-text)
🔇 Additional comments (18)
skills/nemo-relay-plugin-observability/skill-card.md (1)
47-47: Define theNumcolumn.The summary reports 20 evaluation tasks, but every result row uses
Num = 8. Define whatNumcounts or reconcile the summary and table totals.Also applies to: 68-75
skills/nemo-relay-instrument-calls/skill.oms.sig (1)
1-1: 🗄️ Data Integrity & IntegrationNo action needed.
skills/nemo-relay-instrument-context-isolation/skill-card.md (4)
1-1: Add the SPDX header before the generated card.The required repository-standard SPDX HTML comment is still missing. Add it and regenerate the corresponding signature because the signed digest will change.
Source: Coding guidelines
1-81: Normalize or exempt the generated Markdown layout.The card still triggers MD041, MD022, and MD058. Add a top-level title and required blank lines, or document an explicit lint exemption for this generated layout.
Source: Linters/SAST tools
2-2: Link the first product mention.Link the first
NeMo Relaymention to the repository reference already provided later in the card.Source: Coding guidelines
81-81: Replace the generic reporting link text.Replace
[here]with descriptive anchor text and runjust docs-linkcheckafter changing the link.Sources: Coding guidelines, Linters/SAST tools
skills/nemo-relay-instrument-typed-wrappers/BENCHMARK.md (3)
1-1: Add the SPDX header before the benchmark.The required repository-standard SPDX HTML comment is still missing. Add it and regenerate the corresponding signature because the signed digest will change.
Source: Coding guidelines
3-5: Align the evaluation summary with the documented tiers.The report claims
3-Tier Evaluation, but only Tier 1 and Tier 2 are documented. Add Tier 3 or change the summary to describe the two reported tiers.
48-48: Correct singular benchmark wording.Use
1 taskand1 check, not1 tasksand1 checks.Also applies to: 67-67
Source: Coding guidelines
skills/nemo-relay-instrument-typed-wrappers/skill-card.md (4)
1-1: Add the SPDX header before the generated card.The required repository-standard SPDX HTML comment is still missing. Add it and regenerate the corresponding signature because the signed digest will change.
Source: Coding guidelines
1-81: Normalize or exempt the generated Markdown layout.The card still triggers MD041, MD022, and MD058. Add a top-level title and required blank lines, or document an explicit lint exemption for this generated layout.
Source: Linters/SAST tools
2-2: Link the first product mention.Link the first
NeMo Relaymention to the repository reference already provided later in the card.Source: Coding guidelines
81-81: Replace the generic reporting link text.Replace
[here]with descriptive anchor text and runjust docs-linkcheckafter changing the link.Sources: Coding guidelines, Linters/SAST tools
skills/nemo-relay-plugin-observability/BENCHMARK.md (4)
1-1: Add the SPDX header before the benchmark.The required repository-standard SPDX HTML comment is still missing. Add it and regenerate the corresponding signature because the signed digest will change.
Source: Coding guidelines
3-5: Align the evaluation summary with the documented tiers.The report claims
3-Tier Evaluation, but only Tier 1 and Tier 2 are documented. Add Tier 3 or change the summary to describe the two reported tiers.
67-67: Correct singular benchmark wording.Use
1 check, not1 checks.Source: Coding guidelines
13-13: 🎯 Functional CorrectnessClarify the
Numdenominator. The report says the dataset contains 20 evaluation tasks, but every results row usesNum = 8, and there’s no explanation for that subset. DefineNumand the scored subset, or update the table to match the full dataset.skills/nemo-relay-instrument-context-isolation/skill.oms.sig (1)
1-1: 🗄️ Data Integrity & IntegrationVerify both signature bundles after final artifact changes.
skills/nemo-relay-instrument-context-isolation/skill.oms.sig#L1-L1: recompute all embedded resource digests and verify the certificate-backed DSSE signature.skills/nemo-relay-instrument-typed-wrappers/skill.oms.sig#L1-L1: perform the same verification after regenerating the signed Markdown artifacts.
|
/ok to test 1cb7cd8 |
|
/ok to test b4406d9 |
3 participants
Overview
Harden the second Relay skill batch and refresh NVCARPS/NVSkills validation.
Details
This PR keeps the original four-skill batch and adds focused observability security guidance:
The NVSkills service generated benchmark, skill-card, and signature artifacts after the first successful run. The observability signature must be refreshed because its signed inputs changed.
No Relay runtime behavior changes.
Where should the reviewer start?
Start with
skills/nemo-relay-plugin-observability/references/opentelemetry.md, then review the safety contract inskills/nemo-relay-plugin-observability/SKILL.md.Validation
Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)
Summary by CodeRabbit