Repository navigation
docs: shorten the README and move the details to docs/ - #26
Merged
Merged
Conversation
No lite model references waist_pitch_visual.stl or waist_yaw_visual.stl, but both shipped in the wheel and the ament install. The export copied the new meshes over the old ones, so a removed part left its mesh behind. The mesh test now also fails on a mesh that the URDF does not reference. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01FtY7D2vUc6McSBa1Kqq394
package.xml said 0.0.2 and pyproject.toml 0.5.0, so the conda package from pixi-build-ros and the Python package had different versions. A test now checks that the two match. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01FtY7D2vUc6McSBa1Kqq394
Without an <option>, the two MJCFs used Euler. implicitfast is the integrator that the MuJoCo docs recommend, and mjlab, the other variants and most Menagerie robots use it. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01FtY7D2vUc6McSBa1Kqq394
onshape-to-robot drops the mesh collider of each part, and adds the shapes of the scad file with the name of the part. 18 files matched no part, for example the V1 leg colliders of lite_dummy. 8 wrist_yaw files had no shapes, and the forearm file already tells why the wrist has no collider. The generated models do not change. In lite_dummy and lite_bimanual, the hand part has the name fingertip, so its file keeps that name and now says so. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01FtY7D2vUc6McSBa1Kqq394
The script is in workflow/ with the generator, and runs from a checkout through the docs dependency group. Thus the published package gets no new command and no Pillow. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01FtY7D2vUc6McSBa1Kqq394
T-K-233
force-pushed
the
docs/readme-rewrite
branch
from
October 12, 2026 01:18
0b0c944 to
c87fda3
Compare
The README keeps the variants, the usage and the conventions. The collider, ros2_control and generator details move to docs/. The design notes state the limits: simulation-grade geometry only, one collider set per variant, and URDF cylinders against MJCF capsules. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01FtY7D2vUc6McSBa1Kqq394
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01FtY7D2vUc6McSBa1Kqq394
mjlab trains on a plane with no contact attributes. The floors set condim 3 and friction 1 0.005 0.0001, which are the MuJoCo defaults, so they already matched. Without the attributes, the floor reads as the training plane and nobody tunes it away from training. The compiled contacts do not change. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01FtY7D2vUc6McSBa1Kqq394
condim 1 makes only leg-leg contacts frictionless. A contact with the ground takes the larger condim of the two geoms, so a leg on the ground has friction, as in mjlab training. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01FtY7D2vUc6McSBa1Kqq394
T-K-233
force-pushed
the
docs/readme-rewrite
branch
from
October 12, 2026 01:41
c87fda3 to
dbf4c0a
Compare
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.
Rewrites the README for users of the description, moves the maintainer details to
docs/, and fixes the problems that a review of the repository found.Docs
left_knee_pitchcollider is 0.304 m against 0.392 m. Isaac Lab 3.0 removedreplace_cylinders_with_capsules, so the docs give no workaround.colliders.md,ros2_control.mdandgeneration.mdhold the old README sections, the xacro args, the differences between the backends, the contact model, the collider editing steps and an mjlab feet-onlyCollisionCfgexample.python -m lite_description.workflow.render_imagesrendersdocs/images/through a newdocsdependency group. The published package gets no new command and no Pillow.berkeley-humanoids/lite_description. The old URL works only through the GitHub redirect.Fixes
litemeshes that no model references, and clearmeshes/visual/on export. The mesh test now checks both directions.package.xml0.0.2 → 0.5.0, to matchpyproject.toml. A test checks the match.liteandlite_proMJCF:implicitfastinstead of the default Euler, as the MuJoCo docs recommend and the other variants use.condimandfriction, which were the MuJoCo defaults. mjlab trains on a plane with no contact attributes, so the floor now reads as the training plane. The compiled contacts do not change.patch_contactsdocstring:condim1 makes only leg-leg contacts frictionless. A leg on the ground has friction, as in mjlab training.Breaking: the old README anchors
#usage,#hardware-backends,#re-generating-from-cadand#testsare gone.The
_commentinlite_biped/cad/ros2_control.jsonstill says that mock hardware has the IMU block. The docs follow the generated xacro, which has no IMU block for mock hardware.Verification
docs/colliders.mdrun. The viewer script opens the model.uv run --group test pytestpasses at each commit: 108 passed, 32 skipped (the xacro tests).xacrocommand. A reviewer ran the mjlab example with mjlab 1.6.0.🤖 Generated with Claude Code
https://claude.ai/code/session_01FtY7D2vUc6McSBa1Kqq394