-
Notifications
You must be signed in to change notification settings - Fork 52
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-4647: Improve python docs on how to add local module to config #415
Conversation
cc @Fahmina |
eb2e404
to
20a7c67
Compare
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.
Can you update the readme in complex_module and simple_module to also include The aforementioned `type`, `model`, and `name` should be the same as those in the `MODEL` class attribute defined in your custom class.
@@ -481,11 +481,11 @@ | |||
"metadata": {}, | |||
"source": [ | |||
"### 5. Configure a modular resource\n", | |||
"**NOTE:** *These instructions are for local development. Soon we will launch a `Registry` which will allow users to upload modules to app.viam.com directly. We will update the documentation with instructions on how to do that shortly.*\n", | |||
"**NOTE:** *These instructions are for local development. If you are adding your module to the registry, follow [these instructions](https://docs.viam.com/extend/modular-resources/configure/) instead. Otherwise, continue with these instructions, which will show you how to configure the module locally.*\n", |
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.
"**NOTE:** *These instructions are for local development. If you are adding your module to the registry, follow [these instructions](https://docs.viam.com/extend/modular-resources/configure/) instead. Otherwise, continue with these instructions, which will show you how to configure the module locally.*\n", | |
"**NOTE:** *If you are adding your module to the registry, follow [these instructions](https://docs.viam.com/extend/modular-resources/configure/) instead. Otherwise, continue with these instructions, which will show you how to configure the module locally.*\n", |
RSDK-4647
Added note linking to docs for adding to registry
Added sentence clarifying the relationship of the config type, model, name to the component class' type, model, name