Skip to content

docs: remove ROS references and meta sections from documentation - #6

Merged
thetooler merged 2 commits into
mainfrom
docs/remove-ros-references
Sep 30, 2026
Merged

thetooler merged 2 commits into
mainfrom
docs/remove-ros-references

Conversation

@thetooler

Copy link
Copy Markdown
Contributor

Summary

The library never depended on ROS, but its docs and comments described it as the
"ROS-agnostic" layer of a ROS stack, which read as ROS-adjacent to anyone
opening the repository cold. This removes every ROS reference, and drops the
project-management sections from the readmes: the version-scope notice, the
license restatement, and the red-lines note.

No behavior change — comments, descriptions, documentation and the pkg-config
Description field only.

Changes

  • ROS wording removed from README.md, README_zh.md, CMakeLists.txt, package.xml, cmake/litegrip_cpp.pc.in, examples/CMakeLists.txt, src/version.cpp, src/control_loop.cpp, src/safety.cpp, and the control_loop.hpp / gripper.hpp / safety.hpp / can/controller.hpp headers.
  • Where the prose carried information, it was rewritten rather than cut: "ROS-side gate" becomes "the old Python gate", "the node" becomes "the process", ## Non-ROS usage becomes ## Minimal example, my_node becomes my_app, "layer 1" becomes "the bottom layer".
  • package.xml is kept, since it declares the plain-cmake package. Its description is rewritten and the download.ros.org schema processing instruction is removed; the file stays well-formed XML.
  • The colcon / ROS-workspace build note is gone from both readmes and from the CMakeLists.txt design constraints.
  • ## What is not in this version / ## 本版本不包含, ## 许可证, and ## Red lines are not yet unit-specific / ## 红线尚未按本台夹爪重建 are deleted — 35 lines, all deletions, nothing added.
  • The deleted red-lines warning is not lost: it ships with the library in calibration/safety_limits_350.json (★ NOT VERIFIED ON THIS UNIT, plus the re-derivation and max_feedback_velocity_rad_s note) and in include/litegrip/safety.hpp. The v1 capability scope stays in the include/litegrip/gripper.hpp header comment.

Testing

cmake -S . -B build -DCMAKE_BUILD_TYPE=Release   # clean rebuild, no warnings
cmake --build build -j
ctest --test-dir build --output-on-failure       # 100% tests passed, 0 tests failed out of 12
npx --yes markdownlint-cli2@0.23.3 "README.md"   # 0 issues (the CI check)
python3 -c "import xml.dom.minidom as m; m.parse('package.xml')"   # well-formed

No hardware and no CAN interface required — this is the same suite CI runs.

Issues

None — no issue tracks this change.

thetooler added 2 commits September 30, 2026 13:19
The library never depended on ROS, but its docs and comments described it
as the "ROS-agnostic" layer of a ROS stack, which reads as ROS-adjacent
to anyone opening the repository cold. Drop every ROS reference: the
package name, the layer diagram, the colcon build note, and the
ROS-side provenance of the safety ceilings and the control loop.

Prose that carried real information is rewritten rather than deleted —
"the ROS-side gate" becomes "the old Python gate", "the node" becomes
"the process", and "## Non-ROS usage" becomes "## Minimal example".
package.xml is kept (it declares the plain-cmake package) with its
description cleaned and the ros.org schema processing instruction
removed; the resulting file stays well-formed XML.

No behavior change: comments, descriptions, documentation and the
pkg-config Description field only.
The "What is not in this version" section read as a project-management
artifact: it cited an "agreed v1 scope" and listed what was deferred,
which is not what a README is for. The same applies to the license
section — the MIT LICENSE file at the repository root is the statement,
and restating it in one language only made the two readmes diverge.

Also drop the "Red lines are not yet unit-specific" section. Nothing is
lost: the warning ships with the library, verbatim, in the baseline data
(calibration/safety_limits_350.json, "★ NOT VERIFIED ON THIS UNIT" plus
the re-derivation and max_feedback_velocity_rad_s note) and in
include/litegrip/safety.hpp. The fail-closed behaviour it describes is
enforced by the control loop, not by the documentation.

The v1 capability scope stays documented where callers meet it: the
header comment in include/litegrip/gripper.hpp.

No behavior change: README.md loses 15 lines, README_zh.md 20, all
deletions.
@thetooler
thetooler merged commit 470f01f into main Sep 30, 2026
1 check passed
@thetooler
thetooler deleted the docs/remove-ros-references branch September 30, 2026 05:27
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.

1 participant