Skip to content

docs(readme): fix broken links to Gurdrails website - #2046

Merged
Pouyanpi merged 6 commits into
NVIDIA-NeMo:developfrom
medichecks-subrata:patch-1
Jun 22, 2026
Merged

docs(readme): fix broken links to Gurdrails website#2046
Pouyanpi merged 6 commits into
NVIDIA-NeMo:developfrom
medichecks-subrata:patch-1

Conversation

@medichecks-subrata

@medichecks-subrata medichecks-subrata commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

Updated the link to the Supported LLM Models section in the README.

Description

README update.
Fixed broken link!
CleanShot 2026-06-18 at 11 07 45

CleanShot 2026-06-18 at 11 10 39 CleanShot 2026-06-18 at 11 10 39 CleanShot 2026-06-18 at 11 19 12

Related Issue(s)

NA

Verification

NA

AI Assistance

  • No AI tools were used.
  • AI tools were used; a human reviewed and can explain every change (tool: ___).

Checklist

  • I've read the CONTRIBUTING guidelines.
  • This PR links to a triaged issue assigned to me.
  • My PR title follows the project commit convention.
  • I've updated the documentation if applicable.
  • I've added tests if applicable.
  • I've noted any verification beyond CI and any checks I couldn't run.
  • I did not update generated changelog files manually.
  • I addressed all CodeRabbit, Greptile, and other review comments, or replied with why no change is needed.
  • @mentions of the person or team responsible for reviewing proposed changes.

Summary by CodeRabbit

  • Documentation
    • Updated documentation links throughout the README to point to new locations for installation guides, usage references, supported LLM models, and configuration guides.

Updated the link to the Supported LLM Models section in the README.

Signed-off-by: Subrata Mazumder <108659812+medichecks-subrata@users.noreply.github.com>
@github-actions github-actions Bot added status: needs triage New issues that have not yet been reviewed or categorized. size: XS labels Jun 18, 2026
Updated the link in the README for the Installation Guide.

Signed-off-by: Subrata Mazumder <108659812+medichecks-subrata@users.noreply.github.com>
Updated the link in the README for the Configuration Guide.

Signed-off-by: Subrata Mazumder <108659812+medichecks-subrata@users.noreply.github.com>
Updated the link in the Usage section to point to the correct Server Guide.

Signed-off-by: Subrata Mazumder <108659812+medichecks-subrata@users.noreply.github.com>
Signed-off-by: Subrata Mazumder <108659812+medichecks-subrata@users.noreply.github.com>
@medichecks-subrata medichecks-subrata changed the title Fix link to Supported LLM Models in README Fix link to Gurdrails website in README Jun 18, 2026
@medichecks-subrata medichecks-subrata changed the title Fix link to Gurdrails website in README README Update : Fix broken links to Gurdrails website Jun 18, 2026
@medichecks-subrata medichecks-subrata changed the title README Update : Fix broken links to Gurdrails website docs (readme)- fix broken links to Gurdrails website Jun 18, 2026
@Pouyanpi Pouyanpi added status: triaged Triaged by a maintainer; eligible for automated review (CodeRabbit/Greptile). and removed status: needs triage New issues that have not yet been reviewed or categorized. labels Jun 22, 2026
@greptile-apps

greptile-apps Bot commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR fixes broken documentation links in the README by migrating them from old-style .html-suffixed paths to the new URL structure used by the NeMo Guardrails docs site.

  • Six links are updated across the README: Installation Guide, Server Guide, Supported LLM Models, Colang Guide (two occurrences), and the Configuration Guide — all migrated to the new path format.
  • The previously flagged missed occurrence of the Colang 1.0 Language Syntax Guide link at line 220 has been corrected in this PR.
  • A handful of remaining .html-style links (Guardrails Library, Docker, LangChain, LLM Vulnerability Scanning) were not included in this pass and may still be broken.

Confidence Score: 5/5

Safe to merge — this is a documentation-only change that corrects broken links with no effect on code behavior.

All six updated links follow the new docs URL pattern shown in the screenshots provided by the author. The previously missed Colang 1.0 Language Syntax Guide link at line 220 has been corrected. A few older .html-style links remain elsewhere in the README but were already flagged in prior reviews and are not newly introduced by this PR.

No files require special attention.

Important Files Changed

Filename Overview
README.md Six broken documentation links updated to the new URL structure; several other old-style .html links remain on lines 226, 232, 281, 285, and 292 but were not part of this fix.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Old URL Pattern\ndocs.nvidia.com/nemo/guardrails/\nuser-guides/...html] -->|Fixed in this PR| B[New URL Pattern\ndocs.nvidia.com/nemo/guardrails/\npath/without-extension]

    B --> C[get-started/installation-guide]
    B --> D[get-started/integrate-into-application]
    B --> E[about-nemo-guardrails-library/supported-llms]
    B --> F[configure-guardrails/colang x2 occurrences]
    B --> G[configure-guardrails/configure-rails]

    H[Still using old pattern] -->|Not updated| I[user-guides/guardrails-library.html]
    H -->|Not updated| J[user-guides/advanced/using-docker.html]
    H -->|Not updated| K[user-guides/langchain/langchain-integration.html]
    H -->|Not updated| L[evaluation/llm-vulnerability-scanning.html]
Loading
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
flowchart TD
    A[Old URL Pattern\ndocs.nvidia.com/nemo/guardrails/\nuser-guides/...html] -->|Fixed in this PR| B[New URL Pattern\ndocs.nvidia.com/nemo/guardrails/\npath/without-extension]

    B --> C[get-started/installation-guide]
    B --> D[get-started/integrate-into-application]
    B --> E[about-nemo-guardrails-library/supported-llms]
    B --> F[configure-guardrails/colang x2 occurrences]
    B --> G[configure-guardrails/configure-rails]

    H[Still using old pattern] -->|Not updated| I[user-guides/guardrails-library.html]
    H -->|Not updated| J[user-guides/advanced/using-docker.html]
    H -->|Not updated| K[user-guides/langchain/langchain-integration.html]
    H -->|Not updated| L[evaluation/llm-vulnerability-scanning.html]
Loading

Reviews (4): Last reviewed commit: "Fix link to Colang 1.0 Language Syntax G..." | Re-trigger Greptile

@coderabbitai

coderabbitai Bot commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

Five hyperlinks in README.md are updated to new URL paths: the Installation Guide, Server Guide, Supported LLM Models, Colang Guide, and Configuration Guide links each point to a different documentation location than before.

Changes

README Documentation Link Updates

Layer / File(s) Summary
Updated documentation links
README.md
Installation Guide, Server Guide, Supported LLM Models, Colang Guide, and Configuration Guide hyperlinks are each changed to new URL paths in their respective README sections.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 6
✅ Passed checks (6 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
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.
Test Results For Major Changes ✅ Passed This PR only updates documentation links in README.md (+5/-5 lines, size XS), which are minor changes. Per the custom check instruction, minor changes do not require test results.
Title check ✅ Passed The PR title accurately describes the main change—fixing broken links in the README that point to the Guardrails website documentation, which aligns with all documented changes.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

@Pouyanpi Pouyanpi changed the title docs (readme)- fix broken links to Gurdrails website docs(readme): fix broken links to Gurdrails website Jun 22, 2026

@Pouyanpi Pouyanpi left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thank you @medichecks-subrata for fixing these broken links. We should be good to merge after addressing the following comment 👍🏻

Comment thread README.md Outdated
Updated the link for the Colang 1.0 Language Syntax Guide.

Signed-off-by: Subrata Mazumder <108659812+medichecks-subrata@users.noreply.github.com>
@medichecks-subrata

Copy link
Copy Markdown
Contributor Author

Thank you @medichecks-subrata for fixing these broken links. We should be good to merge after addressing the following comment 👍🏻

@Pouyanpi it's now fixed! Kindly have a look again.

@Pouyanpi
Pouyanpi merged commit 3681c01 into NVIDIA-NeMo:develop Jun 22, 2026
4 checks passed
RobGeada pushed a commit to RobGeada/NeMo-Guardrails that referenced this pull request Jul 2, 2026
Signed-off-by: Subrata Mazumder <108659812+medichecks-subrata@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size: XS status: in review status: triaged Triaged by a maintainer; eligible for automated review (CodeRabbit/Greptile).

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants