Document minimum viam-server version for modules#5210
Merged
Conversation
✅ Deploy Preview for viam-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
viambot
added
the
safe to build
btshrewsbury-viam
marked this pull request as ready for review
July 15, 2026 16:42
Julie Krasnick (jckras)
approved these changes
Jul 15, 2026
Julie Krasnick (jckras)
left a comment
Julie Krasnick (jckras)
left a comment
Member
There was a problem hiding this comment.
LGTM, thank u
|
🔎💬 Inkeep AI search and chat service is syncing content for source 'Viam Docs' |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Closes #5205.
Documents the new minimum viam-server version for modules feature (announced 2026-07-14) as additive edits to the module-owner how-to page.
What changed
docs/build-modules/manage-modules.md:## Set a minimum viam-server versionsection: how a module owner sets the minimum from the registry page (right-hand sidebar, pencil-icon edit modal, owners only), how the requirement is stamped per published version and inherited by future publishes, and how to clear it.### Resolve a compatibility warningsubsection: where the advisory banner appears (configured module's card and the add-module search preview) and how a machine builder resolves it (upgradeviam-serveror pin a compatible module version).Source
viam-serverversion.Notes for reviewers
meta.jsonfield. Neither source PR exposes ameta.jsonkey or CLI flag; the setting writes through the existingUpdateRegistryItemflow from the registry page. The live schema athttps://dl.viam.dev/module.schema.jsonhas no min/server/version field.docs/build-modules/module-reference.mdis intentionally left untouched.docs/reference/viam-agent.md"viam-server version" mentions are about the agent choosing a server binary, a different topic; there was no prior owner for this content.