Skip to content

Make the build readable without downloading anything - #1

Merged
correll merged 2 commits into
mainfrom
docs/build-guide-and-renders
Aug 29, 2026
Merged

Make the build readable without downloading anything#1
correll merged 2 commits into
mainfrom
docs/build-guide-and-renders

Conversation

@correll

@correll correll commented Aug 29, 2026

Copy link
Copy Markdown
Contributor

The guide, the models and the photographs were all here; none of them rendered on GitHub. The manual was a PDF, the build photos were HEIC — which GitHub will not preview and Windows and Linux often will not open — and the STLs were twelve file names.

What changed

  • Documentation/assembly.md — the assembly guide as Markdown with the figures inline, so it reads on a phone propped up next to the bench. The PDF stays as the printable version, and tools/extract_guide_figures.py cuts the figures out of it, so re-exporting the guide updates both rather than letting them drift.
  • assembly_photos/ HEIC → JPEG, 63 MB down to 13 MB. The originals stay in history if a full-resolution frame is ever wanted back.
  • Documentation/renders/ — every printed part rendered from its STL by tools/render_stl.py (numpy + Pillow, no CAD kernel): the V2 print set, and the four finger variants side by side. The base plate is rendered from its reverse face on purpose — the printed OpenRB-150 standoffs are the point of that part, and the default three-quarter view hides them.
  • README — what the gripper is, what V2 changed, what to print, and where the software lives. Cross-linked with correlllab/MAGPIE, which gains the matching pointer back in Say what this hand is, and how to build one MAGPIE#2.
  • MIT licence, matching the software repository. Without one, nobody could safely print from these models.
  • The paper is in Documentation/paper/ and cited at the end of the README (recompressed from 17 MB to 1.5 MB; arXiv has the original).

One thing to check before merging

CAD/Base Top.stl and CAD/Base Bottom.stl are the same file, byte for byte, and it is the plate carrying the printed OpenRB-150 standoffs. Either V2 really does use one plate twice — in which case the BOM, which prices them separately, and the guide, which says they are different sizes, are stale — or the second export never made it in. Flagged in the README rather than guessed at.

Two smaller fixes while transcribing the guide: "Repeat Steps 2 through 5" → steps 2 to 4 (step 5 is that step), and "replace is roughness develops" → "replace if". Documentation/README.md also pointed at a Hardware/ folder that does not exist; the BOM lives in Documentation/.

🤖 Generated with Claude Code

The guide, the models and the photographs were all here; none of them
rendered on GitHub. The manual was a PDF, the build photos were HEIC —
which GitHub will not preview and Windows and Linux often will not open —
and the STLs were twelve file names.

- Documentation/assembly.md: the assembly guide as Markdown, figures
  inline, so it reads on the phone propped up next to the bench. The PDF
  stays as the printable version, and tools/extract_guide_figures.py cuts
  the figures out of it, so re-exporting the guide updates both.
- assembly_photos: HEIC -> JPEG, 63 MB down to 13 MB. The originals stay
  in history if a full-resolution frame is ever wanted back.
- Documentation/renders: every printed part rendered from its STL by
  tools/render_stl.py (numpy + Pillow, no CAD kernel), as a print set and
  as the four finger variants side by side. The base plate is rendered
  from its reverse face on purpose — the printed OpenRB-150 standoffs are
  the whole point of that part and the default three-quarter view hides
  them.
- README: what the gripper is, what V2 changed, what to print, and where
  the software lives. The paper it descends from is in Documentation/paper
  and cited at the end.

One thing to check: CAD/Base Top.stl and CAD/Base Bottom.stl are the same
file, byte for byte, and it is the plate carrying the printed standoffs.
Either V2 uses one plate twice — in which case the BOM, which prices them
separately, and the guide, which says they are different sizes, are stale —
or the second export never made it in. Flagged in the README rather than
guessed at.
The models, the bill of materials and the assembly guide had no licence at
all, which in a public repository means nobody may safely print from them —
the opposite of what an open-hardware repo is for. Same MIT terms as
correlllab/MAGPIE, so the gripper and the code that drives it are under one
licence rather than two stories.
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.

2 participants