-
Notifications
You must be signed in to change notification settings - Fork 114
Update README.md for RTI Connext #1253
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]>
WalkthroughUpdated the DDS Shapes Subscriber README to reference RTI Connext instead of RTI Connext Express. Added a link to additional Connext information and a contact email. Minor presentation adjustments with no functional impact. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes
Pre-merge checks✅ Passed checks (2 passed)
Tip 📝 Customizable high-level summaries are now available in beta!You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.
Example instruction:
Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later. 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/dds_shapes_subscriber/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/dds_shapes_subscriber/README.md
**/*.md
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Use Holoscan SDK glossary terms when referring to HoloHub-specific locations in documentation
Files:
operators/dds/dds_shapes_subscriber/README.md
🪛 markdownlint-cli2 (0.18.1)
operators/dds/dds_shapes_subscriber/README.md
8-8: Bare URL used
(MD034, no-bare-urls)
8-8: Bare URL used
(MD034, no-bare-urls)
8-8: Link text should be descriptive
(MD059, descriptive-link-text)
| to downstream operators. | ||
|
|
||
| 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 bare URLs and improve link text clarity.
Line 8 contains bare URLs and non-descriptive link text that violate markdown best practices:
- The bare URL
https://www.rti.com/products/third-party-integrations/nvidiashould be wrapped in a markdown link with descriptive text - The link text
[click here]is non-descriptive; use text that conveys the destination's purpose (e.g., "obtain a license/activation key") - The email
[email protected]should be formatted as a mailto link for consistency
Apply this diff to fix the 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, please [request a license/activation key](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]](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, please [request a license/activation key](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]](mailto:[email protected]) |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
8-8: Bare URL used
(MD034, no-bare-urls)
8-8: Bare URL used
(MD034, no-bare-urls)
8-8: Link text should be descriptive
(MD059, descriptive-link-text)
🤖 Prompt for AI Agents
In operators/dds/dds_shapes_subscriber/README.md around line 8, replace the bare
URL and non-descriptive link text: wrap
https://www.rti.com/products/third-party-integrations/nvidia in a markdown link
with descriptive text (e.g., "RTI Connext NVIDIA integrations"), change the
"[click here]" text to something descriptive like "obtain a license/activation
key" and link it to the provided activation URL, and format [email protected]
as a mailto link (mailto:[email protected]) for consistency.
Greptile OverviewGreptile SummaryUpdated DDS Shapes Subscriber documentation to reference "RTI Connext" instead of "RTI Connext Express", added NVIDIA integration resource link, and included support contact email.
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
Note over Doc: Change to "RTI Connext"
Dev->>Doc: Add NVIDIA integration link
Dev->>Doc: Add support contact email
User->>Doc: Read documentation
Doc-->>User: Updated product info
|
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
| to downstream operators. | ||
|
|
||
| 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.
style: Wrap [email protected] in backticks to prevent platform from interpreting as user mention
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.