Skip to content

docs: drop reverse mount guidance and deprecate template api - #56

Merged
cao-xiao-hao merged 2 commits into
mainfrom
docs/drop-reverse-mount-guidance
Oct 28, 2026
Merged

cao-xiao-hao merged 2 commits into
mainfrom
docs/drop-reverse-mount-guidance

Conversation

@cao-xiao-hao

Copy link
Copy Markdown
Contributor

Summary

Shipped grippers have one mounting, so the normal/reverse distinction is no longer a choice users are taught to make. This removes the reverse-mount guidance from both READMEs, marks the mount/template API as deprecated for backward compatibility, and adds an explicit section on loading a calibration measured on the user's own machine.

No signatures, symbols, or runtime logic change; only documentation and diagnostic text.

Changes

  • Remove the reverse-mount teaching section, reverse troubleshooting row, and can1 template advice from README.md and README.zh-CN.md.
  • Add "Using your own calibration file" / "使用自己标定出来的文件" covering default_calibration_path(channel), explicit load_calibration(path), $LITEGRIP_CALIB, the factory fallback, and post-load verification.
  • Mark GripperConfig::mount(), list_calibration_templates(), calibration_template_path(), and LiteGrip::load_template() deprecated in Doxygen comments. No [[deprecated]] attribute, so -Werror builds keep compiling.
  • Remove normal/reverse labels and mount-template advice from runtime diagnostics in src/gripper.cpp.

Testing

$ cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
Build files have been written to: /home/qaz/litegrip/litegrip-cpp/build

$ cmake --build build -j
[100%] Built target test_control_loop

$ ctest --test-dir build --output-on-failure
100% tests passed out of 14
Total Test time (real) =   3.25 sec
$ npx --yes markdownlint-cli2@0.23.3 "README.md"
Summary: 0 issues in 0 files

No hardware was available; end-to-end movement was not tested.

Issues

No issue.

The shipped grippers have one mounting, so diagnostics no longer branch
on a normal/reverse label and no longer suggest loading a mount template.
Direction is reported as the close_sign value, and a missing calibration
points at the factory file instead.

No behavior changes; only the text of diagnostics.
@cao-xiao-hao
cao-xiao-hao merged commit 2bdbdde into main Oct 28, 2026
1 check passed
@cao-xiao-hao
cao-xiao-hao deleted the docs/drop-reverse-mount-guidance branch October 28, 2026 02:32
@github-actions

Copy link
Copy Markdown

🎉 This PR is included in version 1.1.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

@github-actions github-actions Bot added the released Shipped in a release label Oct 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

released Shipped in a release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant