Repository navigation
Conversation
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
github-actions
Bot
added
status: needs triage
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
miyoungc
added
status: in review
status: triaged
 [Low impact] The changes affect README readers and the contents of automated release pull requests. The quickstart needs a compatible install command before this PR is safe to merge. FindingsFix with agent prompt### Issue 1
README.md:65
The quickstart now installs the released package instead of the development source, but the example needs newer APIs. The latest recorded stable release, `0.24.1`, has no CEL extra or CEL rail, and its `RailType` only contains `INPUT` and `OUTPUT`. Readers following these commands cannot get the shown result.
Keep the development-source install until a release includes these features, or use an example supported by the released package.
### Issue 2
README.md:undefined-253
The linked page only covers library telemetry; it does not contain the promised third-party endpoint terms. This PR also removes the README's explanation that third-party services have separate privacy terms and that the library's opt-out does not cover them. Readers following this link cannot find that guidance. Move it into the linked page or link to a page that contains it.
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.SummaryReworks the GitHub overview around agents, conversational applications, and RAG.
Reviews (4) · Last reviewed commit: "docs: make the quickstart usable with th..." · Reviewed by Greptile |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
| Third-party endpoints have separate terms and privacy practices. The NVIDIA NeMo Guardrails library can use inference endpoints such as NVIDIA Build (`build.nvidia.com`). If you use NVIDIA Build or another third-party endpoint, that endpoint's terms of service and privacy practices apply independently of the library. Any telemetry opt-out in the NVIDIA NeMo Guardrails library does not extend to the endpoint you choose. NVIDIA Build is intended for evaluation and testing only and must not be used in production environments. Do not submit confidential information or personal data when using NVIDIA Build. | ||
|
|
||
| ## Inviting the community to contribute | ||
| Refer to [telemetry and privacy](https://docs.nvidia.com/nemo/guardrails/latest/resources/telemetry) for the full schema, local audit file, opt-out options, and third-party endpoint terms. |
There was a problem hiding this comment.
The linked page only covers library telemetry; it does not contain the promised third-party endpoint terms. This PR also removes the README's explanation that third-party services have separate privacy terms and that the library's opt-out does not cover them. Readers following this link cannot find that guidance. Move it into the linked page or link to a page that contains it.
Prompt To Fix With AI
This is a comment left during a code review.
Path: README.md
Line: 253
Comment:
**Promised privacy guidance is missing**
The linked page only covers library telemetry; it does not contain the promised third-party endpoint terms. This PR also removes the README's explanation that third-party services have separate privacy terms and that the library's opt-out does not cover them. Readers following this link cannot find that guidance. Move it into the linked page or link to a page that contains it.
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
There was a problem hiding this comment.
This finding is outdated at the current PR head. The original wording was corrected in c88c161 and the relevant disclosure is retained in the current Telemetry and Privacy section.
The README no longer promises that the telemetry page contains third-party endpoint terms. It also explicitly states that the usage-telemetry opt-out does not disable configured model or guardrail service calls, and that those calls can send content to their endpoints.
The linked telemetry guide is now offered for telemetry details and opt-out options. The current README therefore addresses the missing disclosure and removes the inaccurate link promise. Please remove this already-addressed finding from the review summary.
There was a problem hiding this comment.
Agreed. The current README has corrected the link’s scope and explicitly discloses that configured model or guardrail service calls can send content to their endpoints, regardless of the usage-telemetry opt-out. This finding is addressed and should be removed from the review summary.
|
No actionable comments were generated in the recent review.
 |
| Layer / File(s) | Summary |
|---|---|
Project framing and release updates README.md, .github/workflows/release.yml |
The README introduces configurable checks for agent workflows and updates project links. The release workflow stops editing the README and removes the related pull request text and path entry. |
Check workflow and quickstart README.md |
The README explains check verdicts and tool execution boundaries, then adds a refund-tool example using a CEL rule, check_async(), and IORails. |
Deployment and check coverage README.md |
The README describes the HTTP proxy, coding-agent hooks, framework integration, check coverage, and supported engines. |
Telemetry and project policies README.md |
The README shortens its telemetry description and updates contribution, license, and citation links. |
Estimated code review effort: 2 (Simple) | ~10 minutes
Change: Other
Suggested labels: documentation
Suggested reviewers: pouyanpi
Merge Risk: 
bec71
-
No actionable merge-blocking risk remains.
Pre-merge checks: 
-
Check name Status Explanation Description Check Check skipped - CodeRabbit’s high-level summary is enabled. Title check The title clearly describes the main change: repositioning the GitHub README around agent workflows. The release workflow update is secondary. Linked Issues check Check skipped because no linked issues were found for this pull request. Out of Scope Changes check Check skipped because no linked issues were found for this pull request. Test Results For Major Changes The PR makes a substantial README and release-workflow documentation change. Its description includes testing information: a network-disabled quickstart run, seven policy and schema boundary checks, t… Full details: Test Results For Major Changes
-
Explanation
The PR makes a substantial README and release-workflow documentation change. Its description includes testing information: a network-disabled quickstart run, seven policy and schema boundary checks, target and URL validation, pre-commit, diff, and documentation checks. No numeric, convergence, or performance change is introduced.
-
Finishing Touches
-
🧪 Generate unit tests (beta)
-
- Commit to this branch
- Create a new PR
-
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Comment @coderabbitai help to get the list of available commands.
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
tgasser-nv
left a comment
tgasser-nv
left a comment
There was a problem hiding this comment.
Thanks for the PR @miyoungc. This has good coverage of agentic use-cases, but is missing all the other capabilities of Guardrails. We still support a range of rails for conversational, RAG, etc. We need to add these into the README as well.
Recommend adding a section at the top with all the use-cases we support including conversational application with input and output rails, RAG, etc. Then each of these can link to a more detailed section below with further information. The PR as it is will be good for agentic / tool-calling usecases
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
PR merge guidance@miyoungc thanks for the PR. GitHub is currently blocking merge for one or more repository requirements:
Relevant guide: |
Description
Make the GitHub overview an entry point for AI agents, conversational applications, and RAG. Introduce the supported use cases near the top, explain the workflow in three bullets and a broader diagram, and link to configuration, integration, and deployment guides for details.
Merge capabilities into “Why NeMo Guardrails,” expand the linked rail catalog, name the Nemotron Safety models and garak, and add Security, Releases, and Changelog navigation. The post-launch quickstart uses
pip install "nemoguardrails[cel]"and a self-contained Python script that checks a refund policy and prints the blocking rail and reason. It requires no clone, editable/development installation, or example files from this repository.Remove the hard-coded release notice and its dependent release-workflow step. The PR changes only README.md and .github/workflows/release.yml.
Preview: https://github.com/NVIDIA-NeMo/Guardrails/blob/miyoungc/ngr-1020-guardrails-github-overview-update/README.md
Related Issue(s)
The tracking issue is in Linear; there is no linked triaged GitHub issue.
Verification
0.25.0rc1wheel and installed it into a temporary package directory. Executed the exact README script outside the checkout with network connections prohibited, and verified imports came from that wheel. Output matched; seven additional policy/schema cases passed. Runtime dependencies were provided by the existing development environment.uv run --locked pre-commit run --files README.md .github/workflows/release.ymlandgit diff --checkpassed.AI Assistance
Codex helped prepare the README and perform local verification. Human review is pending.
Checklist
Summary by CodeRabbit