Skip to content

Commit 6cc3c5b

Browse files
docs: Document editing module short description from the UI (#4871)
Co-authored-by: promptless[bot] <promptless[bot]@users.noreply.github.com> Co-authored-by: promptless[bot] <179508745+promptless[bot]@users.noreply.github.com>
1 parent 7a10cc5 commit 6cc3c5b

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

docs/operate/modules/advanced/manage-modules.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -340,6 +340,17 @@ viam module update
340340
If you don't see a private module of yours in the registry, make sure that you have the correct organization selected in the upper right corner of the page.
341341
{{% /hiddencontent %}}
342342

343+
## Edit the short description
344+
345+
The short description is a brief summary of your module that appears in registry search results.
346+
You can edit it directly from the registry UI without updating your `meta.json` file.
347+
348+
To edit the short description:
349+
350+
1. Navigate to your module's page in the [registry](https://app.viam.com/registry).
351+
2. Click the edit icon next to the short description field.
352+
3. Enter the new description and save your changes.
353+
343354
## Delete a module
344355

345356
You can delete a module if:

0 commit comments

Comments
 (0)