-
Notifications
You must be signed in to change notification settings - Fork 64
RSDK-3836 - update documentation #353
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
RSDK-3836 - update documentation #353
Conversation
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.
Awesome! I've noted some small optional language suggestions for your consideration. Thanks!
Co-authored-by: andf-viam <132301587+andf-viam@users.noreply.github.com>
Co-authored-by: andf-viam <132301587+andf-viam@users.noreply.github.com>
Co-authored-by: andf-viam <132301587+andf-viam@users.noreply.github.com>
Co-authored-by: andf-viam <132301587+andf-viam@users.noreply.github.com>
Co-authored-by: andf-viam <132301587+andf-viam@users.noreply.github.com>
Co-authored-by: andf-viam <132301587+andf-viam@users.noreply.github.com>
Co-authored-by: andf-viam <132301587+andf-viam@users.noreply.github.com>
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! Thanks 🧑🔧
nit: pr name should be in form of |
The docs have been updated to be more consistent with the existing
examples
in the Python SDK as well as the official Viam docs.The changes include:
Sensor
example and adding theArm
example as an additional example at the bottom of theModular Resources
sectionREADME
to mention the new Arm modular componentREADME
, point readers to go to the Python docs if they want to see a more in-depth explanation on how to create a modular component from an existing resourceNOTE: Some of the wording is based off of the actual Viam docs for consistency.
The custom resource
Gizmo
andSummation
module examples were not added to the docs on purpose. It seemed too repetitive without a lot of payoff, as it would be wordy for something that can be more easily shown in GitHub the way it is now. The docs have been updated to point a user to the example, and theREADME
has also been updated to point a reader to the docs for existing resources.