From 20a7c674dc7eb0e9d0cc4bf79860f9053dddaf92 Mon Sep 17 00:00:00 2001 From: hexbabe Date: Thu, 31 Aug 2023 13:22:24 -0400 Subject: [PATCH 1/2] Made first draft of changes according to requirements outlined by Fahmina and Cheuk --- docs/examples/example.ipynb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/examples/example.ipynb b/docs/examples/example.ipynb index fe0ca241b..c1ee85718 100644 --- a/docs/examples/example.ipynb +++ b/docs/examples/example.ipynb @@ -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", "\n", "[Configure your new module](https://docs.viam.com/extend/modular-resources/#configure-your-module) on your robot by navigating to the **Config** tab of the robot's page on the Viam app, then click on the **Modules** subtab. Add the name of your module and the executable path. For our example, the path would be `/wifi-sensor/run.sh`.\n", "\n", - "Once you have configured a module as part of your robot configuration, [configure your modular resource](https://docs.viam.com/extend/modular-resources/#configure-your-modular-resource) made available by that module by adding new components or services configured with your modular resources' new type or model. To instantiate a new resource from your module, specify the `type`, `model`, and `name` of your modular resource. This is a JSON example:\n", + "Once you have configured a module as part of your robot configuration, [configure your modular resource](https://docs.viam.com/extend/modular-resources/#configure-your-modular-resource) made available by that module by adding new components or services configured with your modular resources' new type or model. To instantiate a new resource from your module, specify the `type`, `model`, and `name` of your modular resource. The aforementioned `type`, `model`, and `name` should be the same as those in the `MODEL` class attribute defined in your [component class](#2-register-the-custom-component). This is a JSON example:\n", "\n", "```json\n", "{\n", From 9a2e9c5267036f31578f261e8a4de8ce041c1bd6 Mon Sep 17 00:00:00 2001 From: hexbabe Date: Tue, 5 Sep 2023 15:21:49 -0400 Subject: [PATCH 2/2] Removed redundant sentence as per Cheuk's review --- docs/examples/example.ipynb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/examples/example.ipynb b/docs/examples/example.ipynb index c1ee85718..c45af7afe 100644 --- a/docs/examples/example.ipynb +++ b/docs/examples/example.ipynb @@ -481,7 +481,7 @@ "metadata": {}, "source": [ "### 5. Configure a modular resource\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", + "**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", "\n", "[Configure your new module](https://docs.viam.com/extend/modular-resources/#configure-your-module) on your robot by navigating to the **Config** tab of the robot's page on the Viam app, then click on the **Modules** subtab. Add the name of your module and the executable path. For our example, the path would be `/wifi-sensor/run.sh`.\n", "\n",