Example changes proposed by docsbot on provisioning #4249
Conversation
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
viambot
added
the
safe to build
❌ Deploy Preview for viam-docs failed. Why did it fail? →
|
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.
--- Proposed Documentation Actions ---
Summary: The code changes add device information fields (manufacturer, model, fragment_id) to the Bluetooth provisioning functionality, which are displayed during BLE device discovery. This allows devices to be more easily identified during the provisioning process.
Reasoning:
The code changes add new Bluetooth characteristics for manufacturer, model and fragment ID that are displayed during device discovery. This requires documentation updates in two key places:
The network_configuration reference documentation needs to be updated to document these new configuration fields that can be set to customize the device information shown during BLE provisioning.
The provisioning setup guide needs to be updated to mention that when using BLE provisioning via the mobile app, users will now see identifying device information like manufacturer, model and fragment ID.
The updates provide clearer documentation about this new device identification capability during the provisioning process.
Retrieved Sections informing decision:
[1] File: docs/manage/reference/viam-agent/_index.md
Content: ##
network_configuration...[2] File: docs/manage/fleet/provision/setup.md
Content: ## Decide on the provisioning method
You can choose to let your end users complete machine setup by using a captive web portal or a mobile app....
Planned Edits (Validated):
--- End of Plan ---