Skip to content

Fix doc version update script to handle new url#810

Merged
rapids-bot[bot] merged 1 commit intoNVIDIA:mainfrom
rgsl888prabhu:fix_update_version_for_doc
Feb 3, 2026
Merged

Fix doc version update script to handle new url#810
rapids-bot[bot] merged 1 commit intoNVIDIA:mainfrom
rgsl888prabhu:fix_update_version_for_doc

Conversation

@rgsl888prabhu
Copy link
Copy Markdown
Collaborator

@rgsl888prabhu rgsl888prabhu commented Jan 28, 2026 •
edited by coderabbitai Bot
Loading

Fix doc version update script to handle new url

Checklist

  • I am familiar with the Contributing Guidelines.
  • Testing
    • New or existing tests cover these changes
    • Added tests
    • Created an issue to follow-up
    • NA
  • Documentation
    • The documentation is up to date with these changes
    • Added new documentation
    • NA

Summary by CodeRabbit

  • Chores
    • Updated documentation versioning to introduce version 26.04.00 as the latest release while preserving access to version 26.02.00 for historical reference.

✏️ Tip: You can customize this high-level summary in your review settings.

@rgsl888prabhu rgsl888prabhu self-assigned this Jan 28, 2026
@rgsl888prabhu rgsl888prabhu added the bug Something isn't working label Jan 28, 2026
@rgsl888prabhu rgsl888prabhu requested a review from a team as a code owner January 28, 2026 20:24
@rgsl888prabhu rgsl888prabhu added the non-breaking Introduces a non-breaking change label Jan 28, 2026
@rgsl888prabhu rgsl888prabhu requested a review from a team as a code owner January 28, 2026 20:24
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jan 28, 2026

📝 Walkthrough

Walkthrough

These changes update the documentation version management system. The utility script is modified to use absolute URLs, update copyright information, and implement version entry cleanup logic, while the versions JSON file is updated to reflect the new latest version 26.04.00.

Changes

Cohort / File(s) Summary
Version Management Updates
ci/utils/update_doc_versions.py		 Updated copyright year to 2025-2026; changed URL format from relative path "../{version}/" to absolute URL "https://docs.nvidia.com/cuopt/user-guide/{version}/"; added newline after json.dump() output; implemented logic to remove "latest" named entries and entries with preferred flag before inserting new version entry
Version Configuration
docs/cuopt/source/versions1.json		 Updated latest version from 26.02.00 to 26.04.00 with corresponding URL change; added historical entry for version 26.02.00; remaining version entries unchanged

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: updating the doc version update script to handle a new URL format (changing from relative to absolute NVIDIA docs URL).
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

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

✨ Finishing touches
  • 📝 Generate docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

coderabbitai[bot]
coderabbitai Bot reviewed Jan 28, 2026
View reviewed changes
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
ci/utils/update_doc_versions.py (1)

34-39: Remove "preferred" key regardless of its value.
if version_entry.get("preferred"): won’t remove a preferred: false key, leaving inconsistent schema and potentially confusing downstream consumers that check key presence.

✅ Proposed fix 
-        if version_entry.get("preferred"):
-            version_entry.pop("preferred", None)
+        if "preferred" in version_entry:
+            version_entry.pop("preferred", None)

@rgsl888prabhu rgsl888prabhu added this to the 26.04 milestone Jan 29, 2026
@rgsl888prabhu rgsl888prabhu requested review from jameslamb and removed request for msarahan February 3, 2026 17:17
@rgsl888prabhu
Copy link
Copy Markdown
Collaborator Author

rgsl888prabhu commented Feb 3, 2026

/merge

@rapids-bot rapids-bot Bot merged commit ac400cd into NVIDIA:main Feb 3, 2026
178 of 179 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@tmckayus tmckayus tmckayus approved these changes

@jameslamb jameslamb jameslamb approved these changes

Assignees

@rgsl888prabhu rgsl888prabhu

Labels

bug Something isn't working non-breaking Introduces a non-breaking change

Projects

None yet

Milestone

26.04

Development

Successfully merging this pull request may close these issues.

3 participants

@rgsl888prabhu @tmckayus @jameslamb