Skip to content

Conversation

purplenicole730
Copy link
Member

@purplenicole730 purplenicole730 commented Jul 12, 2023

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:

  • adding a simpler Sensor example and adding the Arm example as an additional example at the bottom of the Modular Resources section
  • suggesting users to go to modular resources before trying custom remotes
  • updating the module example's README to mention the new Arm modular component
  • in the README, 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 resource
  • basic wording fixes

NOTE: Some of the wording is based off of the actual Viam docs for consistency.
The custom resource Gizmo and Summation 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 the README has also been updated to point a reader to the docs for existing resources.

@purplenicole730 purplenicole730 marked this pull request as ready for review July 13, 2023 14:53
@purplenicole730 purplenicole730 requested a review from a team as a code owner July 13, 2023 14:53
Copy link
Contributor

@andf-viam andf-viam left a 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!

purplenicole730 and others added 7 commits July 13, 2023 11:45
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>
Copy link
Member

@benjirewis benjirewis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thanks 🧑‍🔧

@cheukt
Copy link
Member

cheukt commented Jul 13, 2023

nit: pr name should be in form of RSDK-XXXX blah, makes things easier to track and also makes our pr titles more consistent

@purplenicole730 purplenicole730 changed the title Rsdk 3836 update documentation RSDK-3836 - update documentation Jul 13, 2023
@purplenicole730 purplenicole730 merged commit 7654d1b into viamrobotics:main Jul 14, 2023
@purplenicole730 purplenicole730 deleted the RSDK-3836-update-documentation branch July 14, 2023 19:06
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.

4 participants