RSDK-7961: highlight viam sdk section #262
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
npentrel
approved these changes
Sep 24, 2024
npentrel
reviewed
Sep 24, 2024
doc/ViamSDK.md
Outdated
| @@ -0,0 +1,3 @@ | |||
| # Viam SDK Library | |||
|
|
|||
| Robots at your fingertips. | |||
There was a problem hiding this comment.
Open to alternatives but we shouldn't add more occurances of the term robot
Suggested change
| Robots at your fingertips. | |
| Work with your machines and hardware. |
There was a problem hiding this comment.
Not an additional occurrence but a copy from the README.
But you are correct we shouldn't be using robot anymore. This was a pun since the flutter SDK is about connecting your smart phone to machines. I would like it if we could remain punny but obvi don't want to spend too much time on coming up with a new one
Maybe "Smart machines on smart devices"??
njooma
approved these changes
Sep 24, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Jira ticket
There is now a new topic/category called Viam SDK that will show up in the navigation bar. It will show above the "Protobuf Definitions" topic.
NOTE ABOUT VIAM SDK LIBRARY "NECESSARY PROTOS"
There were a couple of protos defined in the viam sdk library under the comment: "Necessary Protos". These proto classes are in the "Protobuf Definitions" category, so cannot be part of the new category. These still show up in the regular viam sdk library link, just without the
Viam SDKtag. These are NOT in the Viam SDK topic.Example showing that the protos are not in the Viam SDK category, but is in the library: