JT V3 edits #3759
JT V3 edits #3759
Conversation
viambot
added
the
safe to build
|
You can view a rendered version of the docs from this PR at https://docs-test.viam.dev/3759 |
JessamyT
force-pushed
the
jtv3
branch
2 times, most recently
from
1e1275b to
2e58971
Compare
There was a problem hiding this comment.
@npentrel This page is an example of where it'd be really handy, at least for now, to keep some version of a tutorials or how-tos page in the dev tools section, that can be linked to from different pages. I initially put it here inside /mobile-app/ because I wanted to use this content as an example and not have it completely deleted. But that doesn't quite make sense since it also has the other languages. I could strip out the other languages and just use a flutter version of it here if necessary, but if we are keeping tutorials in dev-tools I'm thinking I'd like to move it into tutorials and just link to it from here.
There was a problem hiding this comment.
Good point. I think moving to tutorials is an option. The other option is to do something similar to the "Advanced" headers in the AI & Data section and name it "Examples". Move forward with whichever you think is best for now
| @@ -5,5 +5,5 @@ weight: 20 | |||
| layout: "docs" | |||
| type: "docs" | |||
| no_list: true | |||
| description: "TODO" | |||
| description: "Spatially describe your robot's working environment for collision avoidance." | |||
There was a problem hiding this comment.
Same as below; I think "robot" evokes the right image in this context, and we don't need to be as broad as "machine" because a little IoT sensor device doesn't need collision avoidance.
| @@ -5,5 +5,5 @@ weight: 40 | |||
| layout: "docs" | |||
| type: "docs" | |||
| no_list: true | |||
| description: "TODO" | |||
| description: "Move a mobile robot with manual or autonomous navigation." | |||
There was a problem hiding this comment.
I think robot is good in this context because "machines" that move around are often thought of as robots, and this is the non-Viam-specific way to describe the task. There are exceptions, but I think "robot" will create the best understanding in this case.
| weight: 10 | ||
| layout: "docs" | ||
| type: "docs" | ||
| no_list: true | ||
| description: "TODO" | ||
| description: "Create a custom user interface for interacting with machines from a browser." | ||
| --- |
There was a problem hiding this comment.
I think you'll want something for setting up the typescript SDK as well, even if it's just instructions to go to the connect tab and follow the instructions there. This is currently missing the pragmatic instruction for what to do next
There was a problem hiding this comment.
You're right good point.
There was a problem hiding this comment.
Done--lmk what you think
| When you add a modular resource _from the registry_, the module that provides it is automatically added at the same time, generating a configuration card for the modular resource and a separate one for the module. | ||
| If you add a built-in component, there will only be a configuration card for the component. | ||
|
|
||
| ### Modular resource configuration details |
There was a problem hiding this comment.
I wonder whether this and the module config details should stay in reference content. I think most of the time this info here (and the info for module config) will only be used as reference.
There was a problem hiding this comment.
Agreed. Will move.
| {{% alert title="In this page" color="tip" %}} | ||
|
|
||
| - [What hardware is already supported?](#supported-hardware) | ||
| - [Add supported hardware to my machine's configuration](#configure-hardware-on-your-machine) | ||
|
|
||
| {{% /alert %}} | ||
|
|
||
| {{% alert title="See also" color="tip" %}} | ||
|
|
||
| - [Support other hardware by creating a new module](../other-hardware/) | ||
|
|
||
| {{% /alert %}} |
There was a problem hiding this comment.
I think you may want to remove these. You may also want to postpone explaining virtual hardware till later on the page. It currently takes too long to get to the part where you do things
There was a problem hiding this comment.
Put it into a little details expander-LMK what you think of that.
Co-authored-by: Naomi Pentrel <[email protected]>
Co-authored-by: Naomi Pentrel <[email protected]>
No description provided.