DOCS-1270: Improve generic #2143
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
viambot
added
the
safe to build
|
Overall readability score: 55.44 (🟢 +0.01)
View detailed metrics🟢 - Shows an increase in readability
Averages:
View metric targets
|
npentrel
reviewed
Nov 3, 2023
docs/components/generic/_index.md
Outdated
| @@ -14,6 +14,8 @@ no_list: true | |||
|
|
|||
| The _generic_ component {{< glossary_tooltip term_id="subtype" text="subtype" >}} is for custom components that are incompatible with any of the other component APIs. | |||
|
|
|||
| For example, if you have an LED display, it does not make sense to implement it as an arm, camera, or any other existing component subtype because an LED display does not have joints or capture images. | |||
There was a problem hiding this comment.
@andf-viam can you review? I'm not sure my sentence is better but I'd like to avoid "it does not make sense", it just feels like it could sound condescending
Suggested change
| For example, if you have an LED display, it does not make sense to implement it as an arm, camera, or any other existing component subtype because an LED display does not have joints or capture images. | |
| For example, if you have an LED display, the APIs of other component types, such as arm, camera, and so on, do not fit since the APIs assume that the component has properties, such as having joints or the ability to capture images, that an LED display does not have. |
andf-viam
approved these changes
Nov 3, 2023
| 1. Package your modular resource or modular resources as a {{< glossary_tooltip term_id="module" text="module" >}} and [upload the module to the Viam registry](/modular-resources/upload/) to make it available for deployment to robots. | ||
| You can upload _private_ modules for your [organization](/manage/fleet/organizations/) or _public_ modules. | ||
| 1. Once you have uploaded your module to the registry, you can [deploy and configure the module](/modular-resources/configure/) from [the Viam app](https://app.viam.com/). | ||
| You can test your added resource using the [**Control** tab](/manage/fleet/#remote-control) and [program](/program/) it with Viam's Go or Python SDKs. | ||
|
|
||
| ### Unique cases |
There was a problem hiding this comment.
This header works for me, thanks!
Co-authored-by: andf-viam <[email protected]>
npentrel
reviewed
Nov 3, 2023
npentrel
reviewed
Nov 3, 2023
npentrel
reviewed
Nov 3, 2023
|
You can view a rendered version of the docs from this PR at https://docs-test.viam.dev/2143/public |
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.
Removed third bullet point since I believe that case falls under Advanced MR