Skip to content

Update page on custom interfaces#6312

Open
kacperbojakowski-3di wants to merge 2 commits intoros2:rollingfrom
kacperbojakowski-3di:custom-interfaces-howto
Open

Update page on custom interfaces#6312
kacperbojakowski-3di wants to merge 2 commits intoros2:rollingfrom
kacperbojakowski-3di:custom-interfaces-howto

Conversation

@kacperbojakowski-3di
Copy link
Copy Markdown

@kacperbojakowski-3di kacperbojakowski-3di commented Mar 25, 2026

Updated the article "Implementing custom interfaces - how to" as approved by Geoff and 3di.

Description

Related to: ros2/ros2#1725

Updated the custom interfaces how-to page by replacing the old single-package tutorial with the new revised tutorial, and updated the TOC to add the new page entry and remove/replace the old one (incl. the Beginner-Client-Libraries tutorial list).

Did you use Generative AI?

No.

Additional Information

Documentation updates from 3di Information Solutions, agreed with Geoff and Tully.

Updated the article "Implementing custom interfaces - how to" as approved by Geoff and 3di.
@kscottz
Copy link
Copy Markdown
Collaborator

kscottz commented Mar 25, 2026

@kacperbojakowski-3di

You have some liner errors to address.

source/How-To-Guides/Single-Package-Define-And-Use-Interface.rst:173: Each sentence must start on a new line. Break between "a." and "In your workspace" (sentence-count)
source/How-To-Guides/Single-Package-Define-And-Use-Interface.rst:174: Each sentence must start on a new line. Break between "b." and "Source the workspace" (sentence-count)
source/How-To-Guides/Single-Package-Define-And-Use-Interface.rst:213: Each sentence must start on a new line. Break between "c." and "Check the interface" (sentence-count)

Copy link
Copy Markdown
Collaborator

@fujitatomoya fujitatomoya left a comment

Choose a reason for hiding this comment

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

a couple of minor comments. thanks for making contribution.

Comment on lines +5 to +6
Implementing custom interfaces - how-to
=======================================
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.

this is under how-to section, the title seems redundant for me.

Suggested change
Implementing custom interfaces - how-to
=======================================
Implementing custom interfaces
==============================

Comment on lines +12 to +14
::

Area: ROS-framework | Content-type: how-to | Experience: beginner, intermediate
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.

metadata line is placed inside a :: literal block, which means it will render as a code snippet on the page. If this is intended as visible metadata for readers, a literal block feels like an unusual presentation choice?

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants