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.
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-908: Document part 1 of the cloud app API and move robot API #1706
DOCS-908: Document part 1 of the cloud app API and move robot API #1706
Changes from 6 commits
62257ed
dad756e
22bef29
8d1bb78
e7a456d
6f66112
999c1cb
70cde1d
b1c0e41
ea50743
7ef2ba9
60c7c86
002d282
f4f87e1
351a579
1fd8e08
267812e
37b1f64
7eb173c
4eb5ff7
414ac5d
File filter
Filter by extension
Conversations
Jump to
There are no files selected for viewing
Large diffs are not rendered by default.
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.
Hmm, if this is required for every usage of the Cloud API, I would recommend making this a prerequisite step of some kind, rather than a skippable Tip.
The copy "To use ..." is perfect though, that's an ideal intro.
The outro text "Then, run methods on..." could then be something like:
Or similar. Not sure how to introduce
cloud
here, though.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.
Hmm. Maybe I should make it a section analogous to the "Control your ___ with..." section on component pages like https://docs.viam.com/components/base/#control-your-base-with-viams-client-sdk-libraries?
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.
Yes! That looks like just what we need here!!
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'd done it as a tip initially because it is different so didn't want it to look as though it wasn't different, but I think it'll work! will do
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.
Oh also I may have looked and seen this as a tip: https://docs.viam.com/services/vision/#api
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.
Ooh I could see that tip having a similar problem there as well: seemingly-skippable, yet required! Anyways, definitely out of scope for this PR!
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.
Indeed, and on many other service pages as well! Though personally I think the tips are so colorful and eye-catching that it might be ok esp if we changed them to important or something. But indeed a problem for another PR!
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'd suggest breaking up the return here to
(member_list, invite_list)
or something like that.