Skip to content

docs: add conventions and scene configuration guides#302

Merged
juelg merged 1 commit intomasterfrom
docs/issue-270-conventions-configs
May 4, 2026
Merged

docs: add conventions and scene configuration guides#302
juelg merged 1 commit intomasterfrom
docs/issue-270-conventions-configs

Conversation

@juelg
Copy link
Copy Markdown
Contributor

@juelg juelg commented May 4, 2026

Summary

  • add a dedicated RCS conventions guide covering quaternion order, frame conventions, Euler angles, gripper semantics, units, and MuJoCo depth/quaternion caveats
  • add a sim scene configuration guide explaining SimEnvCreatorConfig, key nested config objects, frame relationships, and example setup patterns from the current scene/config API
  • improve discoverability by linking the new pages from the docs landing page, user guide index, and main README
  • add small ASCII diagrams for the axis convention and scene frame hierarchy

Details

This PR is based on the latest master and documents the current scene/config API from:

  • python/rcs/envs/scenes.py
  • python/rcs/envs/configs.py

The new docs also explicitly call out:

  • RCS quaternion order is xyzw
  • MuJoCo free-joint state uses wxyz
  • robot/base frame is x forward, y left, z up
  • gripper convention is 0 = closed, 1 = open
  • Euler angles are roll, pitch, yaw around x, y, z
  • translations are in meters, angles in radians
  • depth frames are stored as metric depth scaled by BaseCameraSet.DEPTH_SCALE = 1000 in uint16

Validation

  • sphinx-build -b html docs docs/_build/html

Closes #270.

@juelg juelg force-pushed the docs/issue-270-conventions-configs branch 4 times, most recently from c6a1e4e to 83044a0 Compare May 4, 2026 07:14
@juelg juelg force-pushed the docs/issue-270-conventions-configs branch from 83044a0 to 69c2ca0 Compare May 4, 2026 07:18
@juelg juelg merged commit bac2da8 into master May 4, 2026
4 checks passed
@juelg juelg deleted the docs/issue-270-conventions-configs branch May 4, 2026 07:20
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.

docs: page that mentions all conventions

1 participant