Skip to content

docs: Document editing module short description from the UI#4871

Merged
shannonbradshaw merged 2 commits intomainfrom
promptless/edit-module-short-description
Apr 1, 2026
Merged

docs: Document editing module short description from the UI#4871
shannonbradshaw merged 2 commits intomainfrom
promptless/edit-module-short-description

Conversation

@promptless
Copy link
Copy Markdown
Contributor

@promptless promptless Bot commented Mar 31, 2026

Open this suggestion in Promptless to view citations and reasoning process

Adds documentation for the new feature that allows module maintainers to edit their module's short description directly from the registry page in the Viam app. The short description appears in registry search results and can now be edited via the UI in addition to updating the meta.json file.

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.
{{% /hiddencontent %}}

## Edit the short description
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added documentation for the new "Edit short description" feature based on PR #11538, which introduces a UI modal for editing the module's short description shown in registry search results. The PR adds edit-description-modal.svelte component and backend support in registry_item.go.

Source: https://github.com/viamrobotics/app/pull/11538

@netlify
Copy link
Copy Markdown

netlify Bot commented Mar 31, 2026

Deploy Preview for viam-docs ready!

Name Link
🔨 Latest commit fae2ae5
🔍 Latest deploy log https://app.netlify.com/projects/viam-docs/deploys/69cc4e53bf8dc000082e38d7
😎 Deploy Preview https://deploy-preview-4871--viam-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 43 (🟢 up 4 from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (no change from production)
SEO: 92 (no change from production)
PWA: 70 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

@CLAassistant
Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@viambot
Copy link
Copy Markdown
Member

viambot commented Mar 31, 2026

👋 Thanks for contributing! A reviewer will look at it on the next working day!

@michaellee1019 michaellee1019 marked this pull request as ready for review March 31, 2026 22:44
@promptless
Copy link
Copy Markdown
Contributor Author

promptless Bot commented Apr 1, 2026

Just a reminder: If you'd like me to act on any feedback you have via Github comments, just type @Promptless in your suggestion and I'll get right on it! (I won't show up in the user dropdown, but I'll process any request that has @Promptless in the comment body.)

@shannonbradshaw shannonbradshaw merged commit 6cc3c5b into main Apr 1, 2026
12 of 13 checks passed
@shannonbradshaw shannonbradshaw deleted the promptless/edit-module-short-description branch April 1, 2026 18:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants