-
Notifications
You must be signed in to change notification settings - Fork 113
Update README.md for RTI Connext #1254
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Signed-off-by: msimmons82 <[email protected]>
WalkthroughDocumentation-only update to the README file that revises the installation branding terminology from "RTI Connext Express" to "RTI Connext" and adds new text with an external link and contact information. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Pre-merge checks✅ Passed checks (2 passed)
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. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
operators/dds/video/README.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
{operators,applications,workflows,gxf_extensions,tutorials}/**/README.md
📄 CodeRabbit inference engine (CONTRIBUTING.md)
README.md must include purpose, usage instructions, requirements, examples, and architecture overview
Files:
operators/dds/video/README.md
**/*.md
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Use Holoscan SDK glossary terms when referring to HoloHub-specific locations in documentation
Files:
operators/dds/video/README.md
🪛 markdownlint-cli2 (0.18.1)
operators/dds/video/README.md
7-7: Bare URL used
(MD034, no-bare-urls)
7-7: Bare URL used
(MD034, no-bare-urls)
7-7: Link text should be descriptive
(MD059, descriptive-link-text)
| [VideoFrame](VideoFrame.idl) DDS topic. | ||
|
|
||
| This operator requires an installation of [RTI Connext Express](https://content.rti.com/l/983311/2025-07-08/q5x1n8) to provide access to the DDS domain, as specified by the [OMG Data-Distribution Service](https://www.omg.org/omg-dds-portal/). To obtain a license/activation key, please [click here](https://content.rti.com/l/983311/2025-07-25/q6729c). Please see the [usage rules](https://www.rti.com/products/connext-express) for Connext Express. | ||
| This operator requires an installation of [RTI Connext](https://content.rti.com/l/983311/2025-07-08/q5x1n8) to provide access to the DDS domain, as specified by the [OMG Data-Distribution Service](https://www.omg.org/omg-dds-portal/). To obtain a license/activation key, please [click here](https://content.rti.com/l/983311/2025-07-25/q6729c). Additional information on Connext can be found here: https://www.rti.com/products/third-party-integrations/nvidia. For any questions, please email [email protected] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fix markdown formatting: wrap bare URLs and improve link text.
The static analysis tools flagged three issues on this line:
- The bare URL
https://www.rti.com/products/third-party-integrations/nvidiashould be wrapped in markdown link syntax. - The email
[email protected]should be formatted (e.g., as a mailto link or wrapped text). - The link text "click here" is not descriptive; consider using text that explains what the link provides (e.g., "obtain a license/activation key").
Apply this diff to address the formatting issues:
-This operator requires an installation of [RTI Connext](https://content.rti.com/l/983311/2025-07-08/q5x1n8) to provide access to the DDS domain, as specified by the [OMG Data-Distribution Service](https://www.omg.org/omg-dds-portal/). To obtain a license/activation key, please [click here](https://content.rti.com/l/983311/2025-07-25/q6729c). Additional information on Connext can be found here: https://www.rti.com/products/third-party-integrations/nvidia. For any questions, please email [email protected]
+This operator requires an installation of [RTI Connext](https://content.rti.com/l/983311/2025-07-08/q5x1n8) to provide access to the DDS domain, as specified by the [OMG Data-Distribution Service](https://www.omg.org/omg-dds-portal/). To [obtain a license/activation key](https://content.rti.com/l/983311/2025-07-25/q6729c), visit the RTI website. Additional information on Connext can be found [here](https://www.rti.com/products/third-party-integrations/nvidia). For any questions, please email [[email protected]](mailto:[email protected]).📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| This operator requires an installation of [RTI Connext](https://content.rti.com/l/983311/2025-07-08/q5x1n8) to provide access to the DDS domain, as specified by the [OMG Data-Distribution Service](https://www.omg.org/omg-dds-portal/). To obtain a license/activation key, please [click here](https://content.rti.com/l/983311/2025-07-25/q6729c). Additional information on Connext can be found here: https://www.rti.com/products/third-party-integrations/nvidia. For any questions, please email [email protected] | |
| This operator requires an installation of [RTI Connext](https://content.rti.com/l/983311/2025-07-08/q5x1n8) to provide access to the DDS domain, as specified by the [OMG Data-Distribution Service](https://www.omg.org/omg-dds-portal/). To [obtain a license/activation key](https://content.rti.com/l/983311/2025-07-25/q6729c), visit the RTI website. Additional information on Connext can be found [here](https://www.rti.com/products/third-party-integrations/nvidia). For any questions, please email [[email protected]](mailto:[email protected]). |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
7-7: Bare URL used
(MD034, no-bare-urls)
7-7: Bare URL used
(MD034, no-bare-urls)
7-7: Link text should be descriptive
(MD059, descriptive-link-text)
🤖 Prompt for AI Agents
In operators/dds/video/README.md around line 7, fix markdown formatting by
replacing the bare URL with a proper markdown link, convert the plain email into
a mailto link (or clearly formatted email text), and replace the non-descriptive
"click here" link text with a descriptive label such as "obtain a
license/activation key"; ensure all three changes follow markdown link syntax
and preserve the existing URLs and intent.
Greptile OverviewGreptile SummaryUpdated documentation to reflect product name change from RTI Connext Express to RTI Connext, and added helpful resources including NVIDIA integration information and contact email for evaluations.
Confidence Score: 4/5
Important Files ChangedFile Analysis
Sequence DiagramsequenceDiagram
participant Dev as Developer
participant Doc as README.md
participant User as End User
Dev->>Doc: Update product name Express → Connext
Dev->>Doc: Remove Express usage rules link
Dev->>Doc: Add NVIDIA integration URL
Dev->>Doc: Add evaluations email contact
User->>Doc: Read updated documentation
Doc-->>User: Current RTI Connext info + resources
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
1 file reviewed, 1 comment
Summary by CodeRabbit
Documentation
✏️ Tip: You can customize this high-level summary in your review settings.