Skip to content

Fix readme to work better with rosindex #194

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Apr 30, 2025
Merged

Fix readme to work better with rosindex #194

merged 1 commit into from
Apr 30, 2025

Conversation

@rkent
Copy link
Contributor

@rkent rkent commented Apr 29, 2025

Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:

  1. Limited scope. Your PR should do one thing or one set of things. Avoid adding “random fixes” to PRs. Put those on separate PRs.
  2. Give your PR a descriptive title. Add a short summary, if required.
  3. Make sure the pipeline is green.
  4. Don’t be afraid to request reviews from maintainers.
  5. New code = new tests. If you are adding new functionality, always make sure to add some tests exercising the code and serving as live documentation of your original intention.

To send us a pull request, please:

  • Fork the repository.
  • Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
  • Ensure local tests pass. (colcon test and pre-commit run (requires you to install pre-commit by pip3 install pre-commit)
  • Commit to your fork using clear commit messages.
  • Send a pull request, answering any default questions in the pull request interface.
  • Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.

@rkent
Copy link
Contributor Author

rkent commented Apr 29, 2025

This partially fixes ros-infrastructure/rosindex#514. rosindex still needs a CSS improvement before this will look well on rosindex.

christophfroehlich
christophfroehlich approved these changes Apr 30, 2025
View reviewed changes
Copy link
Contributor

@christophfroehlich christophfroehlich left a comment

Choose a reason for hiding this comment

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

Thanks for your time looking into this.

Actually, this is already included in #193, I didn't want to open a new PR again :D Sorry for posting the "wrong" example in the rosindex issue:
It seems that the superfluous cell was not the only problem, https://index.ros.org/r/control_toolbox/github-ros-controls-control_toolbox/#rolling is also broken. Is it the empty line before the table? Maybe yes, because https://github.com/ros-controls/ros2_control/blob/master/README.md is rendered correctly.

markdownlint-cli2 also recommends it, and I already fixed this with https://github.com/ros-controls/control_toolbox/pull/339/files

src/control_toolbox/README.md:16 MD058/blanks-around-tables Tables should be surrounded by blank lines [Context: "ROS2 Distro | Branch | Build s..."]

@christophfroehlich christophfroehlich added backport-humble Triggers PR backport to ROS 2 humble. backport-jazzy Triggers PR backport to ROS 2 jazzy. labels Apr 30, 2025
@christophfroehlich christophfroehlich merged commit 07e5f2a into ros-controls:master Apr 30, 2025
6 checks passed
mergify bot pushed a commit that referenced this pull request Apr 30, 2025
@rkent @mergify
Fix readme to work better with rosindex (#194)
fe2d450 
Signed-off-by: R Kent James <[email protected]>
(cherry picked from commit 07e5f2a)
@mergify mergify bot mentioned this pull request Apr 30, 2025
Merged
6 tasks
mergify bot pushed a commit that referenced this pull request Apr 30, 2025
@rkent @mergify
Fix readme to work better with rosindex (#194)
9a4d6f9 
Signed-off-by: R Kent James <[email protected]>
(cherry picked from commit 07e5f2a)
@mergify mergify bot mentioned this pull request Apr 30, 2025
Merged
6 tasks
christophfroehlich pushed a commit that referenced this pull request Apr 30, 2025
@mergify @rkent
Fix readme to work better with rosindex (#194) (#195)
05db2d7 
(cherry picked from commit 07e5f2a)

Signed-off-by: R Kent James <[email protected]>
Co-authored-by: R Kent James <[email protected]>
christophfroehlich pushed a commit that referenced this pull request Apr 30, 2025
@mergify @rkent
Fix readme to work better with rosindex (#194) (#196)
57e1c4b 
Co-authored-by: R Kent James <[email protected]>
@christophfroehlich christophfroehlich mentioned this pull request Apr 30, 2025
Closed
destogl added a commit to b-robotized-forks/control_msgs that referenced this pull request Sep 2, 2025
@destogl
Squashed commit of the following:
b6c0af9 
commit 413595b
Author: Yara Shahin <[email protected]>
Date:   Sun Jun 8 17:57:39 2025 +0200

    battery_states_msg

commit 7da2ac9
Author: Christoph Froehlich <[email protected]>
Date:   Fri Jun 6 11:03:09 2025 +0000

    5.4.1

commit 0d4e065
Author: Christoph Froehlich <[email protected]>
Date:   Fri Jun 6 11:02:56 2025 +0000

    Update changelog

commit 3ba2539
Author: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Date:   Fri Jun 6 12:57:17 2025 +0200

    Update CMake config (ros-controls#212) (ros-controls#216)

    (cherry picked from commit 466ae4a)

    Co-authored-by: Christoph Fröhlich <[email protected]>

commit 1569a6a
Author: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Date:   Fri Jun 6 11:33:28 2025 +0200

    Fix humble binary build (ros-controls#213) (ros-controls#215)

    (cherry picked from commit 02d78ec)

    Co-authored-by: Christoph Fröhlich <[email protected]>

commit 3a4b1ba
Author: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Date:   Mon Jun 2 13:22:05 2025 +0200

    Bump version of pre-commit hooks (ros-controls#208) (ros-controls#210)

commit 72a158f
Author: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Date:   Sun May 25 17:41:39 2025 +0200

    Cleanup and grooming of CI (ros-controls#205) (ros-controls#207)

    (cherry picked from commit 4643983)

    Co-authored-by: Christoph Fröhlich <[email protected]>

commit d236cce
Author: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Date:   Sun May 11 11:30:32 2025 +0100

    Add Kilted Kaiju and use downstream Jazzy branches (ros-controls#193) (ros-controls#202)

commit 4075a60
Author: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Date:   Thu May 1 11:48:32 2025 +0200

    Bump version of pre-commit hooks (ros-controls#197) (ros-controls#199)

commit 05db2d7
Author: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Date:   Wed Apr 30 15:38:42 2025 +0200

    Fix readme to work better with rosindex (ros-controls#194) (ros-controls#195)

    (cherry picked from commit 07e5f2a)

    Signed-off-by: R Kent James <[email protected]>
    Co-authored-by: R Kent James <[email protected]>

commit ee66392
Author: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Date:   Sun Apr 13 09:39:44 2025 +0200

    Update README.md to be consistent within ros-controls (ros-controls#184) (ros-controls#192)

commit 5a23c1b
Author: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Date:   Thu Apr 3 17:19:14 2025 +0200

    Add copyright owner (ros-controls#188) (ros-controls#190)

commit 1a2237f
Author: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Date:   Wed Apr 2 17:55:24 2025 +0200

    Bump version of pre-commit hooks (ros-controls#185) (ros-controls#187)

commit 75fafd3
Author: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Date:   Sun Mar 16 23:29:26 2025 +0100

    Update branch for downstream job (ros-controls#180) (ros-controls#182)

    Co-authored-by: Christoph Fröhlich <[email protected]>

commit 32cc617
Author: Christoph Froehlich <[email protected]>
Date:   Wed Mar 12 08:50:34 2025 +0000

    5.4.0

commit a831c20
Author: Christoph Froehlich <[email protected]>
Date:   Wed Mar 12 08:50:16 2025 +0000

    Update changelog

commit 91465db
Author: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Date:   Wed Mar 12 09:46:18 2025 +0100

    Branch for jazzy (ros-controls#175) (ros-controls#177)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@christophfroehlich christophfroehlich christophfroehlich approved these changes

@saikishor saikishor saikishor approved these changes

@bmagyar bmagyar Awaiting requested review from bmagyar

@DasRoteSkelett DasRoteSkelett Awaiting requested review from DasRoteSkelett

@destogl destogl Awaiting requested review from destogl

@mcbed mcbed Awaiting requested review from mcbed

@peterdavidfagan peterdavidfagan Awaiting requested review from peterdavidfagan

@progtologist progtologist Awaiting requested review from progtologist

@xguay xguay Awaiting requested review from xguay

Assignees

No one assigned

Labels

backport-humble Triggers PR backport to ROS 2 humble. backport-jazzy Triggers PR backport to ROS 2 jazzy.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@rkent @christophfroehlich @saikishor