Conversation
The XTac-UMI G1 documentation site is being trimmed and its three SDK pages (overview, install & build, examples) are retired in favour of this repo's docs/. Everything those pages said that docs/ did not already cover, or covered with older wording, is merged into the existing files; nothing that docs/ already has is duplicated. - ARCHITECTURE.md: §1.1 components by role and command-set version; §8 note that the lerobot layer does not use the SDK Camera - INSTALL.md: Python >= 3.10 (pyproject), Ubuntu 22.04/24.04, cwd note for submodule use, --no-build-isolation to match README, §5c add_subdirectory integration (no find_package), §6 hardware self-check (empty-SN sources, ModemManager) - EXAMPLES.md: ota_update.py CRC32/role checks and --force, C++ leader_demo smoke program with a minimal C++17 example, follower motor-control section using the scripts that currently exist - CALIBRATION.md: once-per-leader note; same-side duplicate SN refusal - USAGE.md: §0 healthy-output and troubleshooting rows for empty SN / Unknown role and ModemManager Every added statement was checked against the current sources (pyproject, python/examples, cpp headers). Content the site had that is now stale (callbacks on the producer thread, deleted example scripts, the "falls back to a constant" calibration claim) was deliberately not carried over. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
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.
Why
The XTac-UMI G1 documentation site is being trimmed. Its three SDK pages (概览 / 安装与构建 / 示例) are retired and the site now just links to this repo's
docs/. This PR merges into the existing files everything those pages said thatdocs/did not already cover, or covered with older wording. Nothing thatdocs/already has is duplicated.What changed
ARCHITECTURE.md(+33)CameraINSTALL.md(+48/−4)pyproject, Ubuntu 22.04/24.04, cwd note for submodule use,--no-build-isolationto match README, new §5cadd_subdirectoryintegration (nofind_package), §6 hardware self-checkEXAMPLES.md(+62/−1)ota_update.pyCRC32/role checks and--force; C++leader_demosmoke program with a minimal C++17 example; follower motor-control section using the scripts that currently existCALIBRATION.md(+6/−2)USAGE.md(+8/−6)Unknownrole and ModemManagerEvery added statement was checked against the current sources (
pyproject.toml,python/examples/,cpp/include). Site content that is now stale was deliberately not carried over: callbacks-on-producer-thread, the deletedrerun_dual_with_tracker/v4l2_*/motor_mit_controlscripts, and the "falls back to dividing by a constant" calibration claim (README says construction raisesProtocolError).Two things to confirm
INSTALL.md§5a now sayspip install -e . --no-build-isolation, matching README. If the omission in INSTALL was intentional, revert that one line.EXAMPLES.mdsections are in Chinese, following the file's most recent sections; theota_update.pytable row stays English.Noticed but not changed (outside this PR)
USAGE.md§1.4 and README still use--side rightalthough CHANGELOG Unreleased switched to a positional argument; ARCHITECTURE says command set V2.1 while README says V2.2; the ARCHITECTURE module diagram still lists "MIT control, V4L2 probes" underpython/examples/.🤖 Generated with Claude Code