Skip to content

Simplify documentation and QoS configuration - #1

Merged
s2015-turtle merged 2 commits into
mainfrom
refactor/simplify-readme-qos-config
Jul 21, 2026
Merged

Simplify documentation and QoS configuration#1
s2015-turtle merged 2 commits into
mainfrom
refactor/simplify-readme-qos-config

Conversation

@s2015-turtle

@s2015-turtle s2015-turtle commented Jul 21, 2026

Copy link
Copy Markdown
Owner

Summary

  • simplify the public README by removing internal transport and protocol details
  • replace numeric CAN communication-type terminology with user-facing descriptions
  • shorten duplicated configuration examples and package architecture notes
  • remove the deprecated can_qos_depth alias and accept only can_rx_qos_depth
  • remove the logger dependency that existed only for the deprecation warning
  • run feature-branch CI through pull_request only while retaining post-merge push CI on main

Motivation

The README mixed user instructions with internal implementation details, making
the supported configuration and normal operating behavior harder to identify.
The repository has not completed its first rosdistro release, so retaining the
old QoS parameter alias adds ambiguity without providing meaningful release
compatibility.

Validation

  • git diff --check
  • confirmed that can_qos_depth and legacy_qos no longer occur in tracked implementation or documentation files
  • confirmed all parse_driver_configuration declarations and call sites use the updated signature
  • local build was intentionally not run; the existing GitHub Actions matrix will validate Humble, Jazzy, Kilted, Lyrical, and Rolling

@s2015-turtle
s2015-turtle marked this pull request as ready for review July 21, 2026 12:03
@s2015-turtle s2015-turtle self-assigned this Jul 21, 2026
@s2015-turtle s2015-turtle added documentation Improvements or additions to documentation ci Continuous integration and build configuration maintenance Refactoring, cleanup, and repository maintenance labels Jul 21, 2026
@s2015-turtle
s2015-turtle merged commit c0b0709 into main Jul 21, 2026
5 checks passed
@s2015-turtle
s2015-turtle deleted the refactor/simplify-readme-qos-config branch July 21, 2026 12:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci Continuous integration and build configuration documentation Improvements or additions to documentation maintenance Refactoring, cleanup, and repository maintenance

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant