docs: remove ROS references and meta sections from documentation - #6
Merged
Merged
Conversation
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
Descriptionfield only.Changes
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 thecontrol_loop.hpp/gripper.hpp/safety.hpp/can/controller.hppheaders.## Non-ROS usagebecomes## Minimal example,my_nodebecomesmy_app, "layer 1" becomes "the bottom layer".package.xmlis kept, since it declares the plain-cmake package. Its description is rewritten and thedownload.ros.orgschema processing instruction is removed; the file stays well-formed XML.CMakeLists.txtdesign constraints.## What is not in this version/## 本版本不包含,## 许可证, and## Red lines are not yet unit-specific/## 红线尚未按本台夹爪重建are deleted — 35 lines, all deletions, nothing added.calibration/safety_limits_350.json(★ NOT VERIFIED ON THIS UNIT, plus the re-derivation andmax_feedback_velocity_rad_snote) and ininclude/litegrip/safety.hpp. The v1 capability scope stays in theinclude/litegrip/gripper.hppheader comment.Testing
No hardware and no CAN interface required — this is the same suite CI runs.
Issues
None — no issue tracks this change.