Skip to content

docs: fix all broken docs.nvidia.com links in root README - #2399

Open
sven-rankov wants to merge 2 commits into
NVIDIA-NeMo:developfrom
sven-rankov:docs/fix-readme-doc-links
Open

sven-rankov wants to merge 2 commits into
NVIDIA-NeMo:developfrom
sven-rankov:docs/fix-readme-doc-links

Conversation

@sven-rankov

@sven-rankov sven-rankov commented Sep 22, 2026 •

Copy link
Copy Markdown

Description

The documentation site was reorganized and six link destinations in the root
README still point at the old URL scheme, returning 404. This updates them to
their current locations. Text and link labels are unchanged — only the URLs move.

Scope note: the "Getting Started Guide" link is also broken, but it is already
tracked in #2381, so it is deliberately left untouched here to avoid overlapping
with that issue.

Related Issue(s)

Fixes #2395
Issue assignee: (not yet assigned)

Verification

  • Each of the six replacement URLs returns HTTP 200 (curl -sL -o /dev/null -w '%{http_code}').
  • Swept every docs.nvidia.com link in the README (16 unique): after this change
    the only remaining 404 is the getting-started link tracked in doc: Broken 'Getting Started Guide' link in root README #2381.
  • pre-commit run --files README.md passes.
  • No code paths touched, so no test suite run is applicable.

AI Assistance

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

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. (not applicable — documentation links only)
  • 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 README links for Colang 2.0, the guardrails catalog, Docker, LangChain, security, and telemetry documentation.

@github-actions github-actions Bot added status: needs triage New issues that have not yet been reviewed or categorized. size: XS labels Sep 22, 2026
@sven-rankov sven-rankov changed the title docs: fix broken docs.nvidia.com links in root README docs: fix all broken docs.nvidia.com links in root README Sep 22, 2026
@sven-rankov
sven-rankov marked this pull request as ready for review September 22, 2026 21:13
The documentation site was reorganized and several root README links
still pointed at the old URL scheme, returning 404. Update the six
affected destinations to their current locations:

- Colang 2.0 guide -> configure-guardrails/colang/colang-2
- Guardrails library (two links) -> configure-guardrails/guardrail-catalog
- Using Docker -> more-deployment-options/using-docker
- LangChain integration -> integration-with-third-party-libraries/langchain/langchain-integration
- Security Guidelines -> resources/guidelines
- Telemetry -> resources/telemetry

Each replacement URL was verified to return HTTP 200.

The "Getting Started Guide" link is tracked separately in NVIDIA-NeMo#2381 and is
intentionally left unchanged here to keep the scopes from overlapping.

Signed-off-by: Tsvetan Rankov <tsvetan.rankov@gmail.com>
@sven-rankov
sven-rankov force-pushed the docs/fix-readme-doc-links branch from 8d12fe1 to a18a9cb Compare September 23, 2026 10:39
@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 Sep 25, 2026
@Pouyanpi
Pouyanpi requested a review from miyoungc September 25, 2026 12:40
@coderabbitai

coderabbitai Bot commented Sep 25, 2026

Copy link
Copy Markdown
Contributor

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository: NVIDIA-NeMo/Guardrails/.coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 87d406da-6ef2-487f-b69e-842ef9aa52ed

📥 Commits

Reviewing files that changed from the base of the PR and between 71487ba and a18a9cb.

📒 Files selected for processing (1)
  • README.md

Included review availability: Your plan provides up to 12 included reviews per hour; 11 remain after this review.


📝 Walkthrough

Walkthrough

The README links for Colang 2.0, the guardrails catalog, Docker, LangChain, security guidelines, and telemetry now point to updated documentation paths. The LangChain integration instructions remain unchanged.

Changes

README documentation links

Layer / File(s) Summary
Update documentation links
README.md
The README links for Colang 2.0, the guardrails catalog, Docker, LangChain, security guidelines, and telemetry now use updated documentation paths. The LangChain integration instructions are unchanged.

Priority: ⬇️ Low

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

Change: Other · Severity of issue fixed: Low

Merge Risk: ⚪ Minimal · up to a18a9

The README link updates have no established issue in the supplied review context; the reported URL and README-check results are consistent with merging.

🚥 Pre-merge checks | ✅ 6
✅ Passed checks (6 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: updating broken documentation links in the root README.
Linked Issues check ✅ Passed Issue #2395 requires six outdated documentation destinations to be updated in the root README. The PR changes seven link occurrences: Colang 2.0, two Guardrails Library/catalog links, Docker, LangChai…
Out of Scope Changes check ✅ Passed The reported changes are limited to root README documentation links covered by issue #2395. No unrelated code or documentation changes are reported. The unchanged Getting Started Guide is outside the …
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Test Results For Major Changes ✅ Passed PASS — The pull request changes only README.md and replaces documentation URLs; it introduces no feature, breaking change, refactoring, numeric, convergence, or performance change. The description als…
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR

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

@greptile-apps

greptile-apps Bot commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

RetriggerView in GreptileConfidence Score: 5/5

[Low impact] The PR appears safe to merge; no actionable issues were found.

Summary

Updates six documentation destinations across seven links in README.md.

  • The README’s documentation links now lead to their current pages.

Reviews (2) · Last reviewed commit: "ci: retrigger PR checks" · Reviewed by Greptile

@miyoungc miyoungc 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.

Reviewed with assistance from Codex. All six replacement documentation URLs resolve to the intended pages and match the documentation navigation. Changed-file pre-commit, including ty, and git diff --check passed at a18a9cb. No actionable findings.

@Pouyanpi
Pouyanpi self-requested a review October 29, 2026 18:01
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
@github-actions

Copy link
Copy Markdown
Contributor

PR merge guidance

@sven-rankov thanks for the PR. GitHub is currently blocking merge for one or more repository requirements:

  • 1 commit does not have a verified signature (43c7d76). Please sign the commits and force-push the updated branch.

Relevant guide:

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

needs: signing size: XS 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.

doc: fix remaining broken docs.nvidia.com links in root README

3 participants