Skip to content

docs: fold the docs-site SDK appendix into docs/ - #13

Closed
Vertax42 wants to merge 1 commit into
mainfrom
docs/port-sdk-appendix-from-docs-site
Closed

Vertax42 wants to merge 1 commit into
mainfrom
docs/port-sdk-appendix-from-docs-site

Conversation

@Vertax42

@Vertax42 Vertax42 commented Sep 3, 2026

Copy link
Copy Markdown
Collaborator

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 that docs/ did not already cover, or covered with older wording. Nothing that docs/ already has is duplicated.

What changed

File Added
ARCHITECTURE.md (+33) §1.1 components by role and command-set version; §8 note that the lerobot layer does not use the SDK Camera
INSTALL.md (+48/−4) Python ≥ 3.10 per pyproject, Ubuntu 22.04/24.04, cwd note for submodule use, --no-build-isolation to match README, new §5c add_subdirectory integration (no find_package), §6 hardware self-check
EXAMPLES.md (+62/−1) 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 (+6/−2) once-per-leader note; same-side duplicate SN refusal
USAGE.md (+8/−6) §0 healthy-output and troubleshooting rows for empty SN / Unknown role and ModemManager

Every 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 deleted rerun_dual_with_tracker / v4l2_* / motor_mit_control scripts, and the "falls back to dividing by a constant" calibration claim (README says construction raises ProtocolError).

Two things to confirm

  • INSTALL.md §5a now says pip install -e . --no-build-isolation, matching README. If the omission in INSTALL was intentional, revert that one line.
  • New EXAMPLES.md sections are in Chinese, following the file's most recent sections; the ota_update.py table row stays English.

Noticed but not changed (outside this PR)

USAGE.md §1.4 and README still use --side right although 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" under python/examples/.

🤖 Generated with Claude Code

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>
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