Skip to content

docs: consumer integration skill for CI - #189

Open
exactlyallan wants to merge 1 commit into
mainfrom
docs/nvcarps-ci-validation
Open

docs: consumer integration skill for CI#189
exactlyallan wants to merge 1 commit into
mainfrom
docs/nvcarps-ci-validation

Conversation

@exactlyallan

@exactlyallan exactlyallan commented Aug 7, 2026

Copy link
Copy Markdown
Collaborator

Overview

Clarifies the NVIDIA NeMo Fabric consumer skill's integration boundary with a direct imperative. This intentionally trivial documentation change provides a consumer skill delta for validating the NVCARPS CI path.

No public SDK behavior changes or breaking changes are introduced.

Details

  • Replaces "Stay on the public, in-memory contract" with "Use the public, in-memory contract."
  • Leaves the supported integration boundary and all technical guidance unchanged.

Validation

  • .venv/bin/python /Users/aenemark/.codex/skills/.system/skill-creator/scripts/quick_validate.py skills/nemo-fabric-integrate (Skill is valid!)
  • jq empty skills/nemo-fabric-integrate/evals/evals.json
  • git diff --check

Broader documentation and runtime tests were not run because this is a one-line prose-only skill change.

Where should the reviewer start?

skills/nemo-fabric-integrate/SKILL.md, in the opening sentence under Integration Boundary.

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

  • Relates to: none

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

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

Summary by CodeRabbit

  • Documentation
    • Updated integration guidance to clearly instruct users to use the public, in-memory contract.

Use a direct imperative in the consumer skill's integration boundary guidance. This prose-only change is intended to exercise the NVCARPS skill CI path without altering the public SDK contract.

Validation: consumer skill quick validator; eval JSON parsing; git diff --check.
Signed-off-by: Allan Enemark <exactly.allan@gmail.com>
@exactlyallan
exactlyallan requested a review from a team as a code owner August 7, 2026 22:13
@coderabbitai

coderabbitai Bot commented Aug 7, 2026

Copy link
Copy Markdown

Review Change Stack

Walkthrough

The integration-boundary guidance now uses imperative wording: “Use the public, in-memory contract.”

Changes

Integration Guidance

Layer / File(s) Summary
Update boundary instruction
skills/nemo-fabric-integrate/SKILL.md
Replaces “Stay on” with “Use” in the public, in-memory contract instruction.

Estimated code review effort: 1 (Trivial) | ~2 minutes


Important

Pre-merge checks failed

Please resolve all errors before merging. Addressing warnings is optional.

❌ Failed checks (1 error)

Check name Status Explanation Resolution
Title check ❌ Error The title uses the allowed docs type and stays within the length limit, but its summary is not written as an imperative. Rewrite the summary as an imperative, such as "docs: clarify consumer integration boundary".
✅ Passed checks (4 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description check ✅ Passed The description includes the required overview, reviewer starting point, related-issues field, validation details, and confirmation checkboxes.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/nvcarps-ci-validation

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

@exactlyallan exactlyallan changed the title docs: clarify consumer integration boundary docs: consumer integration skill for CI Aug 7, 2026
@exactlyallan exactlyallan self-assigned this Aug 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants