Repository navigation
Document machine-wide resource name uniqueness - #5460
Open
Jeremy Rose (jeremyrose-viam) wants to merge 2 commits into
Open
Jeremy Rose (jeremyrose-viam) wants to merge 2 commits into
Jeremy Rose (jeremyrose-viam) wants to merge 2 commits into
Conversation
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
…tree-resource-name-uniqueness-docs
✅ 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
This branch has not been deployed
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
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.
Documents the
viam-servercontract that component and service names must be unique across the whole machine, even across different APIs. Shipped in RDK v1.6.0 (rdk PR 6350, RSDK-14326). Closes DOCS-4939.docs/hardware/configure-hardware.md: new "Resource names" subsection under step 2. States the uniqueness rule, that it includes remote and fragment resources, thatbuiltinis reserved for the default services, and what happens on a collision (local resources are not built along with their dependents; a local resource wins over a remote one, which is hidden).docs/hardware/machine-configuration.md: thenamefield row says unique across the machine and links to the subsection.docs/hardware/multi-machine/add-a-remote-part.mdandoverview.md: explain that colliding remote resources are hidden and that a prefix prevents it.docs/monitor/troubleshoot.md: tells readers with a missing resource to search the logs forname collision.Pre-PR checks (prettier 3.2.5, markdownlint, vale 3.16.0 locally,
frontmatter_rules.py,make build-prod) passed before merging current main.