nasa-jpl / open-source-rover

A build-it-yourself, 6-wheel rover based on the rovers on Mars!
https://open-source-rover.readthedocs.io
Apache License 2.0
8.54k stars 1.35k forks source link

Hard to notice OnShape model + Slack community link on REAMDE #484

Open ldang opened 2 days ago

ldang commented 2 days ago

This is something I've noticed when building the rover and also from talkign to other people building the rover.

For some reason, it's difficult to notice that there is an OnShape 3D CAD model we can use. And also, it's unclear how to join the Slack.

I think it might be an issue of the information not being located in the right area of the document to be relevant to the user. Most of the time, we end up skimming the document for the information of interest, and then read it more carefully from there. Being reminded of the OnShape model would be most useful around the Rover Build Map section.

For the Slack issue, I think people who are not familiar with Slack will not understand how to join Slack, and also, it's unexpected that a giant Slack logo is an active link.

Generally, it's better to be repetitive for important pieces of information, so there are multiple places for people to get the information, even if they skimmed over the place where it's explained in detail.

Achllle commented 2 days ago

The OnShape model is both mentioned on the main page in its own section, and on the mechanical README page:

Along with the pictures in each folder's README document, open the OnShape model so you can see what goes where and spin it around. Note that the OnShape model does not have all screws included to keep the model speedy and light.

in the mechanical/body/README page:

pay close attention to the placement of the beams using the image below and the online OnShape model.

twice in the rocker_bogie README:

Tip: Use the OnShape model and navigate to the tab 'rocker-bogie' in the bottom to isolate this assembly. Then right click on various parts to temporarily hide them so you can see how the assembly works in 3D.

NOTE: the OnShape model may represent the orientation of the slits incorrectly. In order to make the model nimble, the same rocker-bogie assembly is used on both sides of the rover which has the side-effect that the two assemblies aren't mirrorred like they are supposed to be. Always stop to think about what you're building to avoid having to take things apart later.

I agree that the Slack link could be in text as well. PR welcome. Similar to the above, Slack is suggested 4 other times throughout the instructions in the parts_list, examples, rocker_bogie READMEs.