Skip to content

feat(studio): Add Guardrails and Virtual Model docs - #792

Merged
htolentino-nvidia merged 2 commits into
mainfrom
nvb6478756-add-guardrail-docs/htolentino
Jul 20, 2026
Merged

feat(studio): Add Guardrails and Virtual Model docs#792
htolentino-nvidia merged 2 commits into
mainfrom
nvb6478756-add-guardrail-docs/htolentino

Conversation

@htolentino-nvidia

@htolentino-nvidia htolentino-nvidia commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

https://nvbugspro.nvidia.com/bug/6478756

Summary by CodeRabbit

  • Documentation
    • Added documentation for managing Guardrail Configs, including viewing details, search filtering, and deletion guidance.
    • Added documentation for Virtual Models, including listing behaviors, middleware pipeline stages, filtering, and details panels.
    • Updated Studio navigation to include new Guardrail Configs and Virtual Models pages.

Signed-off-by: Henrique Tolentino <htolentino@nvidia.com>
@htolentino-nvidia
htolentino-nvidia requested review from a team as code owners July 20, 2026 18:50
@github-actions github-actions Bot added the feat label Jul 20, 2026
@coderabbitai

coderabbitai Bot commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 7cb3cad8-d7c1-4d4f-8575-83f48d98112b

📥 Commits

Reviewing files that changed from the base of the PR and between d8a3aac and 6f15217.

📒 Files selected for processing (2)
  • docs/studio/index.mdx
  • docs/studio/virtual-models.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/studio/virtual-models.mdx

📝 Walkthrough

Walkthrough

Added NeMo Studio documentation for Guardrail Configs and Virtual Models, including navigation entries, overview content, list and detail views, management actions, and middleware pipeline details.

Changes

Studio documentation

Layer / File(s) Summary
Studio navigation and overview
docs/fern/versions/latest.yml, docs/studio/index.mdx
Adds navigation entries and overview descriptions for Guardrail Configs and Virtual Models.
Studio workflow pages
docs/studio/guardrails.mdx, docs/studio/virtual-models.mdx
Documents list and detail views, filtering, deletion, configuration fields, and middleware pipelines.

Possibly related PRs

Suggested labels: docs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the main change: adding Studio docs for Guardrails and Virtual Models.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch nvb6478756-add-guardrail-docs/htolentino

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 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 `@docs/studio/index.mdx`:
- Line 52: Update the Virtual Models description in docs/studio/index.mdx (line
52) to say the default backend model is shown “when configured.” Apply the same
optional wording to the “Default model” description in
docs/studio/virtual-models.mdx (line 32), and note there that request middleware
can handle routing when default_model_entity is omitted.

In `@docs/studio/virtual-models.mdx`:
- Line 9: Update the Virtual Models documentation to describe autoprovisioned
models as controller-managed, rather than platform-created, since users can set
the field manually to opt into controller cleanup. Apply this wording
consistently at docs/studio/virtual-models.mdx lines 9 and 33.
🪄 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: CHILL

Plan: Enterprise

Run ID: 2bd7080a-842e-483a-80db-89113b172814

📥 Commits

Reviewing files that changed from the base of the PR and between 5a23930 and d8a3aac.

📒 Files selected for processing (4)
  • docs/fern/versions/latest.yml
  • docs/studio/guardrails.mdx
  • docs/studio/index.mdx
  • docs/studio/virtual-models.mdx

Comment thread docs/studio/index.mdx Outdated
Comment thread docs/studio/virtual-models.mdx Outdated
@github-actions

github-actions Bot commented Jul 20, 2026

Copy link
Copy Markdown
Contributor
Suite Lines Covered Line Rate Branch Rate
Unit Tests 26385/34036 77.5% 61.8%
Integration Tests 15175/32661 46.5% 18.7%

Signed-off-by: Henrique Tolentino <htolentino@nvidia.com>
@htolentino-nvidia
htolentino-nvidia added this pull request to the merge queue Jul 20, 2026
Merged via the queue into main with commit 593fb16 Jul 20, 2026
61 checks passed
@htolentino-nvidia
htolentino-nvidia deleted the nvb6478756-add-guardrail-docs/htolentino branch July 20, 2026 22:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants