Skip to content

feat(omx): integrate interactive 3D assembly guide - #84

Merged
sunghowoo merged 4 commits into
mainfrom
feature-omx-assembly-update
Oct 6, 2026
Merged

sunghowoo merged 4 commits into
mainfrom
feature-omx-assembly-update

Conversation

@Woojin-Crive

Copy link
Copy Markdown
Member

Summary

Replace the video-only OMX Assembly Guide with preparation instructions and an embedded, interactive 3D workspace at the existing documentation URL. Readers can inspect each connection, change the camera view, replay assembly steps, and resume progress locally. The original assembly videos remain available in the Videos view.

  • Support OMX Leader and Follower, with visual selection of BIC30 or legacy XL4015 hardware. Legacy differences are scoped to the upper link, converter mounting, and wiring.
  • Include part/package labels, sequential fastening and connector insertion, frame-guided cable routing, and shareable model/step links.
  • Explain factory-preset actuator IDs and horn reference marks using CAD-derived WebP illustrations.
  • Isolate the Three.js viewer in a same-origin iframe, load only the selected model, and release the viewer when leaving the 3D view.
  • Integrate model preparation, viewer tests, and asset checks into the Docusaurus build, CI, and Docker development workflow. Use Node.js 22.12+ for the viewer toolchain.

Assets and maintenance

The three losslessly compressed model exports total approximately 36.4 MB in Git. SHA-256 manifests verify decompression; the built application keeps one shared asset copy across locales. Original STEP/Gerber/Blender sources, generated bundles, and new rendered films are not included. The application README documents asset provenance and illustration regeneration. Three.js and Inter notices are included separately from ROBOTIS asset and trademark rights.

Validation

  • 33 viewer regression tests passed; Docusaurus type checking passed.
  • English and Korean production builds passed individually, following the repository's per-locale build workflow. Existing HTML-minifier and Node.js 26 localStorage warnings remain.
  • Verified the deployed guide, Follower BIC30/XL4015 switching, and deep-link loading; compared deployed HTML/model/image hashes with the local build.
  • Formatting and staged whitespace checks passed.

Preview the assembly guide

Hardware-specific instructions and mobile interaction still benefit from reviewer validation; automated checks do not replace a physical assembly review.

Embed a same-origin assembly viewer with Leader and Follower hardware variants, part-level motion, cable routing, and preparation illustrations. Build the viewer alongside Docusaurus and retain the original assembly videos as references.
Finish fastening the Follower base actuator before installing OpenRB-150 in both converter variants, preserving stable completion labels and cumulative part visibility.

Keep the Leader base translucent during underside fastening without blocking picking or location markers, and correct the M2 x 6 package labels. Update sequence coverage and mechanical fixtures.
Use en dashes for joint and actuator ID ranges so Markdown does not interpret paired tildes as strikethrough.

@sunghowoo sunghowoo left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@YoungWook0533 YoungWook0533 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great!

@sunghowoo
sunghowoo merged commit fe92586 into main Oct 6, 2026
1 check passed
@sunghowoo
sunghowoo deleted the feature-omx-assembly-update branch October 6, 2026 00:33
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.

4 participants