-
Notifications
You must be signed in to change notification settings - Fork 43
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DOCS-2889: Turn access arm tutorial into how-to #3650
DOCS-2889: Turn access arm tutorial into how-to #3650
Conversation
## Move the arm | ||
|
||
The two main options for specifying arm movement are through **joint position commands** and through **pose commands**. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can you add some info on what these are and why you might choose one or the other?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm going to ask Esha and Ray whether we should just take out the pose command stuff from this tutorial anyway since they are deprecated and the motion service does the same thing.
Edit: Per slack convo (cc'ed Sierra), sounds like we can leave in for now (or not, but probably easier to leave in). TBD what happens with this API anyway.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@JessamyT can you check what I wrote on line 114? not entirely sure if that's the best description
docs/how-tos/move-robot-arm.md
Outdated
{{% tablestep %}} | ||
**1. Initiate motion with a joint position command** | ||
|
||
Add the following code to your script: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think put that inside the tabs under the import and above the code? That's less awkward
Love the GIFs and how this is looking. I think @JessamyT might actually be a better reviewer so tagging her here as well |
assets/how-tos/access-arm/config.png
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This image is oddly narrow--I know we don't like to add too much whitespace but I imagine most people will use at least a slightly wider browser window. Most of our config screenshots are a bit wider than this which I'd recommend so that it looks more like what people will see, and so that it fits into the page content more nicely.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Deleting the image anyways
Big fan of the GIFs! |
I think it'd be good to show the full code at the end. |
Co-authored-by: JessamyT <[email protected]> Co-authored-by: Naomi Pentrel <[email protected]>
docs/how-tos/move-robot-arm.md
Outdated
{{<imgproc src="/tutorials/motion/access_01_xarm6.png" resize="500x" declaredimensions=true alt="A picture of the UFACTORY xArm 6." style="width: 150px" class="fill alignleft" >}} | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this actually looks weird here I think let's remove
{{<imgproc src="/tutorials/motion/access_01_xarm6.png" resize="500x" declaredimensions=true alt="A picture of the UFACTORY xArm 6." style="width: 150px" class="fill alignleft" >}} |
docs/how-tos/move-robot-arm.md
Outdated
|
||
{{< /alert >}} | ||
|
||
{{< alert title="Caution" color="caution" >}} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To avoid having two alerts here, let's put this with the Move the arm section
docs/how-tos/move-robot-arm.md
Outdated
weight: 70 | ||
type: "docs" | ||
tags: ["arm", "components"] | ||
images: ["/tutorials/motion/preview.jpg"] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can you add your gif as a preview here?
removed line numbers |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM once Jessamy approves
Thoughts on showing the full script? Some sections still have line numbers so the mix looks odd. Either remove from all or add to all with somewhat correct-ish numbers. |
@JessamyT I don't think the full script is necessary for a how-to. unless you feel strongly otherwise I'm fine with it as-is |
You can view a rendered version of the docs from this PR at https://docs-test.viam.dev/3650 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
https://docs-test.viam.dev/3650/how-tos/move-robot-arm/