Add release notes to main repository for quick view

[rgsl888prabhu]

Description

Create a soft link to release notes in docs for quick view

Issue

closes #511

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

• Documentation
  • Added release notes documentation structure.

[coderabbitai]

Walkthrough

A new release notes documentation file was added to the cuOpt documentation structure at docs/cuopt/source/release-notes.rst. This change supports linking release notes directly from the main documentation to provide users with easy access to version-specific information.

Changes

Cohort / File(s)	Summary
Documentation - Release Notes docs/cuopt/source/release-notes.rst	New file added to documentation structure for release notes

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A new page appears in the docs so bright,
Release notes awaiting their light,
Users will find what's new with each version,
No more lost searches—just direct conversion! ✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Linked Issues Check	⚠️ Warning	Issue #511 specifically requests that "release notes (or link to it) included in the main README page" to make them easily discoverable when new versions are released. However, the raw_summary indicates that the change adds a file at "docs/cuopt/source/release-notes.rst", which is located within the docs subfolder rather than in the main repository root or README. The PR objectives mention creating a soft link "in the docs" for quick view, but this does not directly address the core requirement of adding release notes accessibility to the main README as explicitly requested in the linked issue.	The PR should be updated to ensure that release notes or a link to them is added to the main README file in the repository root, as specified in issue #511. While the soft link in the docs structure may improve organization, the primary objective was to make release notes discoverable from the main README where users would first encounter documentation. Consider adding or updating the main README to reference the release notes more prominently.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The pull request title "Add release notes to main repository for quick view" is clear and directly related to the main objective of the PR, which is to create a soft link to release notes for improved discoverability. The title is concise, specific, and accurately reflects the primary change without vague terminology or unnecessary noise.
Out of Scope Changes Check	✅ Passed	The addition of a file at docs/cuopt/source/release-notes.rst is related to the general goal of making release notes more discoverable and accessible, which aligns with the objectives outlined in issue #511. While the specific location (docs subfolder rather than main README) differs from the issue's primary request, the change is still within the scope of improving release notes visibility and does not introduce unrelated functionality or modifications to unrelated parts of the codebase.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 282c52b and f7bd5cc.

📒 Files selected for processing (1)

• RELEASE_NOTES.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

RELEASE_NOTES.md

[grammar] ~1-~1: There might be a mistake here.
Context: ===================== Release Notes ===================== ===...

(QB_NEW_EN)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)

• GitHub Check: wheel-build-cuopt-mps-parser / 13.0.1, 3.12, amd64, rockylinux8
• GitHub Check: wheel-build-cuopt-mps-parser / 13.0.1, 3.10, amd64, rockylinux8
• GitHub Check: wheel-build-cuopt-mps-parser / 13.0.1, 3.11, amd64, rockylinux8
• GitHub Check: wheel-build-cuopt-sh-client / 13.0.1, 3.10, amd64, rockylinux8
• GitHub Check: checks / check-style

🔇 Additional comments (1)

RELEASE_NOTES.md (1)

1-1: ****

The file is neither empty nor minimally populated. The actual file (docs/cuopt/source/release-notes.rst) contains comprehensive release notes with ~300+ lines of well-organized, properly formatted reStructuredText including:

• Versions covered: 25.10, 25.08, 25.05
• Sections per version: New Features, Breaking Changes, Improvements, Bug Fixes, Documentation
• Proper RST formatting: Correct heading markers, inline GitHub PR links in proper reStructuredText syntax
• Discoverable content: Directly addresses the PR goal ("quick view" of release notes) and issue [DOC] Add a direct link to the latest release notes when new versions (eg. 25.10) are released. #511 goal (making release notes easily discoverable)

The original concerns about empty content, malformed RST, and missing structure are unfounded. No changes are required.

Likely an incorrect or invalid review comment.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[rgsl888prabhu]

@coderabbitai help

[coderabbitai]

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

CodeRabbit commands

These commands are invoked using PR/Issue comments.

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai evaluate custom pre-merge check --instructions <custom-checks-instructions> --name <custom-checks-title> [--mode <error|warning>] to validate the custom pre-merge checks instructions. Defaults to error when --mode is omitted.
  • @coderabbitai ignore pre-merge checks to override pre-merge checks and get an approval on PR.
  • @coderabbitai run pre-merge checks to run pre-merge checks on the pull request.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve to resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore or @coderabbit ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit configuration file (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, support, documentation and community

• Visit our status page to check the current availability of CodeRabbit.
• Create a ticket on our support page for assistance with any issues or questions.
• Visit our documentation site for detailed information on how to use CodeRabbit.
• Join our Discord community to connect with other users and get help from the community.
• Follow us on X/Twitter for updates and announcements.