-
Notifications
You must be signed in to change notification settings - Fork 3
KOB-50814 update the add iOS devices guide #380
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
…st and some screenshots
WalkthroughDocumentation expands iOS onboarding: generalizes network requirements, clarifies per-mode trust responsibilities (Standard vs Lightning), adds a Lightning iOS 17.4+ flow, refines trust/error-handling and debug-symbol transfer sequencing, and replaces Android assets with iOS-specific screenshots and imagery. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
participant Tech as Technician
participant Dev as iOS Device
participant Mac as Mac mini (Host)
participant GEM as GEM (Lightning)
participant Finder as Finder
participant Xcode as Xcode
rect rgb(240,240,255)
Note over Tech,Dev: Standard Mode / general flow
Tech->>Mac: Connect device via USB
Mac->>Dev: Finder/Xcode may trigger Trust prompt
alt Trust prompt shown
Tech->>Dev: Tap Trust (enter passcode)
else Finder shows device but no Trust button
Finder->>Tech: Device visible — skip Trust step
end
Tech->>Xcode: Open Devices & Simulators
Xcode->>Dev: Transfer debug symbols
Note over Xcode,Dev: Wait until transfer completes before moving device
end
sequenceDiagram
autonumber
participant Tech as Technician
participant Dev as iOS Device (17.4+)
participant GEM as GEM (Lightning)
participant Mac as Mac mini (Host)
participant Xcode as Xcode
rect rgb(240,255,240)
Note over Tech,Dev: Lightning Mode (iOS 17.4+)
Tech->>GEM: Connect device to GEM
GEM->>Dev: GEM must be trusted by device
alt Trust prompt shown
Tech->>Dev: Tap Trust for GEM (enter passcode)
end
Tech->>Mac: Move device to Mac mini (USB)
Mac->>Dev: Mac mini must be trusted by device
alt Trust prompt shown
Tech->>Dev: Tap Trust for Mac (enter passcode)
end
Tech->>Xcode: Open Devices & Simulators
Xcode->>Dev: Transfer debug symbols
Note over Xcode,Dev: Wait until transfer completes
Tech->>GEM: Reconnect to GEM
alt Trust prompt reappears
Tech->>Dev: Tap Trust again if prompted
end
end
Estimated code review effort🎯 4 (Complex) | ⏱️ ~35 minutes Suggested reviewers
Poem
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. ✨ Finishing Touches🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
🧹 Nitpick comments (4)
docs/modules/device-lab-management/pages/ios-devices/add-ios-device.adoc (4)
31-48: Scope clarified correctly; minor grammar fix in this sectionThe network requirements section correctly scopes to Lightning mode on iOS 17.0–17.3.1 and references the anchor later. One small grammar issue: “Prepare a network that satisfy…” should be “satisfies” (singular “network”).
Apply:
-Prepare a network that satisfy the following requirements: +Prepare a network that satisfies the following requirements:
83-99: Trust flow (iOS 16 and below): fix preposition and standardize UI formatting
- “plugging the device to” → “plugging the device into.”
- Use consistent formatting for UI labels (“Trust” button). Elsewhere in the doc you bold the button labels; here it mixes italics and bold.
- Minor phrasing tweak: “changes to the below” → “changes as shown below.”
-After plugging the device to the appropriate system, check the device screen. Tap **Trust** on the Trust this computer popup: +After plugging the device into the appropriate system, check the device screen. Tap **Trust** on the “Trust This Computer” prompt: -Open **Finder** in the Mac mini host, select the connected device name, and choose **Trust**. If the device appears in Finder but there is no _Trust_ button, skip this step. +Open **Finder** on the Mac mini host, select the connected device name, and choose **Trust**. If the device appears in Finder but there is no **Trust** button, skip this step. -Unplug the device, then plug it in again. Wait until the device screen changes to the below before continuing. There will also be an *automation running* overlay above the device screen. +Unplug the device, then plug it in again. Wait until the device screen changes as shown below before continuing. There will also be an *automation running* overlay above the device screen.
122-128: Standard mode (iOS 17+): align UI string capitalization and consistencyCapitalize the iOS prompt to match the literal string and consistently bold UI terms.
-After plugging the device into the Mac mini host, open *Xcode* then navigate to **Window → Devices and Simulators**. Do this before continuing to the next step. +After plugging the device into the Mac mini host, open **Xcode**, then navigate to **Window → Devices and Simulators**. Do this before continuing to the next step. -When the *Trust this computer* prompt on the device screen appears, tap **Trust**. If the *Trust this computer* prompt reappears, tap **Trust** again until there is no more prompt. +When the **Trust This Computer** prompt appears on the device, tap **Trust**. If the prompt reappears, tap **Trust** again until there are no more prompts.
132-159: Lightning mode (iOS 17.0–17.3.1): polish for consistency and clarity
- Keep UI strings literal and bold (“Trust This Computer”, “Trust”).
- Minor grammar/flow polish for readability.
-The device needs to be trusted by both of the below: +The device needs to be trusted by both of the following: -* the Mac mini host that is paired with the GEM (Dell server) -* the GEM it is plugged into. +* The Mac mini host that is paired with the GEM (Dell server). +* The GEM the device is plugged into. -Connect the devices and the Mac mini host to a network that xref:#network-requirements-wifi-pairing[satisfies the requirements]. +Connect the devices and the Mac mini host to a network that xref:#network-requirements-wifi-pairing[satisfies the requirements]. -Open Xcode on the Mac mini host, then navigate to **Window → Devices and Simulators**. Do this before continuing to the next step. +Open **Xcode** on the Mac mini host, then navigate to **Window → Devices and Simulators**. Do this before continuing to the next step. -When the *Trust this computer* prompt on the device screen appears, tap *Trust*. If the *Trust this computer* prompt appears again, tap *Trust* until there is no more prompt. +When the **Trust This Computer** prompt appears on the device, tap **Trust**. If the prompt appears again, tap **Trust** until there are no more prompts. -Wait for the debug symbol transfer process to finish, then unplug the device from the Mac mini host and plug it into the Cambrionix hub connected to the GEM. +Wait for the debug symbol transfer to finish, then unplug the device from the Mac mini host and plug it into the Cambrionix hub connected to the GEM. -The *Trust this computer* prompt will appear again to ask for trust pairing with the GEM. Tap *Trust*. +The **Trust This Computer** prompt will appear again to establish trust with the GEM. Tap **Trust**.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (3)
docs/modules/device-lab-management/images/device-lab-management-add-ios-screen-changes-to-blue.PNGis excluded by!**/*.pngdocs/modules/device-lab-management/images/device-lab-management-ios-add-ios-localhost-system-ios-device-available.PNGis excluded by!**/*.pngdocs/modules/device-lab-management/images/device-lab-management-ios-add-ios-standard-lightning-trust.PNGis excluded by!**/*.png
📒 Files selected for processing (1)
docs/modules/device-lab-management/pages/ios-devices/add-ios-device.adoc(3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Test Build
- GitHub Check: publish-docs-test
- GitHub Check: publish-docs-test
🔇 Additional comments (2)
docs/modules/device-lab-management/pages/ios-devices/add-ios-device.adoc (2)
181-181: LGTM on status indicator stepThe “automation running” overlay callout and the confirmation screenshot step help users verify readiness.
31-175: Assets and cross-references verified
All referenced images, xref targets, and local anchors indocs/modules/device-lab-management/pages/ios-devices/add-ios-device.adocare present and resolve correctly. No changes required.
docs/modules/device-lab-management/pages/ios-devices/add-ios-device.adoc
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🔭 Outside diff range comments (1)
docs/modules/device-lab-management/pages/ios-devices/add-ios-device.adoc (1)
57-57: Conflict with Lightning mode (iOS 17.4+) flow — instructs to trust on Mac mini first.This line contradicts the dedicated “Lightning mode - iOS 17.4 and above” section (Lines 165–175), which says to trust the GEM directly. Clarify the split by iOS versions here.
-For Lightning mode with iOS 17 and above, connect the device to one of the USB ports of the Mac mini host to establish trust pairing first, then follow the next section before connecting the device to the Cambrionix hub attached to the GEM. +For Lightning mode with iOS 17.0 to 17.3.1, connect the device to one of the USB ports of the Mac mini host to establish trust pairing first. For Lightning mode with iOS 17.4 and above, connect the device to the Cambrionix hub attached to the GEM.
♻️ Duplicate comments (1)
docs/modules/device-lab-management/pages/ios-devices/add-ios-device.adoc (1)
169-175: Lightning mode (iOS 17.4+): finish applying grammar/style fixes.Alt text is now for Lightning mode (good), but keep “prompt” (not “popup”) and bold the Trust button to match the rest. This follows up on the prior review note.
-After plugging the device into the Cambrionix hub connected to the GEM, the **Trust This Computer** prompt appears. Tap *Trust*. +After plugging the device into the Cambrionix hub connected to the GEM, the **Trust This Computer** prompt appears. Tap **Trust**. -image::device-lab-management:device-lab-management-ios-add-ios-standard-lightning-trust.PNG[width=300,alt="Lightning Mode. Trust This Computer popup, tapping Trust"] +image::device-lab-management:device-lab-management-ios-add-ios-standard-lightning-trust.PNG[width=300,alt="Lightning Mode. Trust This Computer prompt, tapping Trust"]
🧹 Nitpick comments (8)
docs/modules/device-lab-management/pages/ios-devices/add-ios-device.adoc (8)
36-36: Grammar: subject–verb agreement (“satisfies”).“network” is singular; use “satisfies”.
-Prepare a network that satisfy the following requirements: +Prepare a network that satisfies the following requirements:
88-88: Trust prompt wording and preposition fixes.Use “into,” reference the exact UI string, and prefer “prompt.”
-After plugging the device to the appropriate system, check the device screen. Tap **Trust** on the Trust this computer popup: +After plugging the device into the appropriate system, check the device screen. When the **Trust This Computer** prompt appears, tap **Trust**:
92-92: Scope Finder step to Standard mode and fix style/wording.In Lightning mode (iOS 16 and below here), the device isn’t connected to the Mac mini, so Finder on the Mac mini won’t apply. Also fix “in the Mac mini host,” UI bolding, and phrasing.
-Open **Finder** in the Mac mini host, select the connected device name, and choose **Trust**. If the device appears in Finder but there is no _Trust_ button, skip this step. +If the device is connected to the Mac mini host (Standard mode), open **Finder** on the Mac mini, select the device, and choose **Trust**. If the device appears in Finder but there is no **Trust** button, skip this step.Please confirm whether any Finder-equivalent action is required on the GEM for Lightning mode (iOS 16 and below). If not, scoping the Finder step to Standard mode avoids confusion.
96-98: Tighten phrasing and call out the overlay label.Use “as shown below,” and clarify the overlay wording.
-Unplug the device, then plug it in again. Wait until the device screen changes to the below before continuing. There will also be an *automation running* overlay above the device screen. +Unplug the device, then plug it in again. Wait until the device screen changes as shown below before continuing. An “automation running” overlay also appears above the device screen.
126-129: Standard mode: normalize UI capitalization and terminology; fix image alt.Use “Trust This Computer,” bold UI strings, prefer “prompt,” and “tapping” on a device.
-When the *Trust this computer* prompt on the device screen appears, tap **Trust**. If the *Trust this computer* prompt reappears, tap **Trust** again until there is no more prompt. +When the **Trust This Computer** prompt appears on the device, tap **Trust**. If the prompt reappears, tap **Trust** again until it no longer appears. -image::device-lab-management:device-lab-management-ios-add-ios-standard-lightning-trust.PNG[width=300,alt="Standard Mode. Trust This Computer popup, clicking Trust"] +image::device-lab-management:device-lab-management-ios-add-ios-standard-lightning-trust.PNG[width=300,alt="Standard Mode. Trust This Computer prompt, tapping Trust"]
145-149: Lightning (17.0–17.3.1): consistency for Xcode styling, UI strings, and terminology.Align Xcode formatting and “Trust This Computer” usage across the doc.
-Open Xcode on the Mac mini host, then navigate to **Window → Devices and Simulators**. Do this before continuing to the next step. +Open *Xcode* on the Mac mini host, then navigate to **Window → Devices and Simulators**. Do this before continuing to the next step. -When the *Trust this computer* prompt on the device screen appears, tap **Trust**. If the *Trust this computer* prompt appears again, tap *Trust* until there is no more prompt. +When the **Trust This Computer** prompt appears on the device, tap **Trust**. If the prompt appears again, tap **Trust** until it no longer appears. -image::device-lab-management:device-lab-management-ios-add-ios-standard-lightning-trust.PNG[width=300,alt="Lightning Mode. Trust This Computer popup, clicking Trust"] +image::device-lab-management:device-lab-management-ios-add-ios-standard-lightning-trust.PNG[width=300,alt="Lightning Mode. Trust This Computer prompt, tapping Trust"]
155-159: Clarify sequencing and fix grammar; bold UI strings.Strengthen wording around symbol transfer completion and fix plural/singular mismatch.
-Wait for the debug symbol transfer process to finish, then unplug the device from the Mac mini host and plug it into the Cambrionix hub connected to the GEM. +Wait for the debug symbol transfer to complete. Then unplug the device from the Mac mini host and plug it into the Cambrionix hub connected to the GEM. -The *Trust this computer* prompt will appear again to ask for trust pairing with the GEM. Tap *Trust*. +The **Trust This Computer** prompt will appear again to request trust pairing with the GEM. Tap **Trust**. -In Xcode’s _Devices and Simulators_, the iOS 17 devices will now have a globe icon next to it like below: +In Xcode’s **Devices and Simulators**, each iOS 17 device now has a globe icon next to its name, as shown below:
225-225: Fix inline code formatting and spacing.Remove the extra backtick and stray space before “if”.
-* ``~/Library/Developer/DeveloperDiskImages ``if the current Xcode version is below 16. +* `~/Library/Developer/DeveloperDiskImages` if the current Xcode version is below 16.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/modules/device-lab-management/pages/ios-devices/add-ios-device.adoc(3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: publish-docs-test
- GitHub Check: Test Build
🔇 Additional comments (2)
docs/modules/device-lab-management/pages/ios-devices/add-ios-device.adoc (2)
181-181: Alt text is clear.Good, concise description of the visual change.
128-129: Assets and navigation verified ✅All referenced images exist in the repository, and docs/modules/device-lab-management/nav.adoc includes an xref to ios-devices/add-ios-device.adoc. No further action needed.
erincbailey
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
couple questions
| The device needs to be trusted by both of the following: | ||
| Open Xcode on the Mac mini host, then navigate to **Window → Devices and Simulators**. Do this before continuing to the next step. | ||
| * The Mac mini host that is paired with the GEM (Dell server) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Chris said that for a GEM system, plugging the device into the Mac and accepting trust prompts there has no effect. You only need to trust with the GEM. Is that just for core devices above iOS 17.4?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For iOS 17.0 to 17.3.1 (without CoreDevice), the only way to have the second trust prompt show up is to connect the device to the Mac mini with Xcode opened. Connecting it to the GEM with Xcode opened on the Mac does not display the second trust prompt.
The second trust prompt, when not trusted, will make the device offline.
It's been a while since I performed this process, but things may change with the latest deviceConnect versions. I will have to re-verify on that.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Did you reverify?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
already did. It's the same behaviour as before.
| Open Xcode. | ||
|
|
||
| Tap Trust in the **Trust this computer** popup on the iOS 17 device. The **Trust this computer** prompts will reappear, tap **Trust** again. After this, there should be no more **Trust** prompts. | ||
| Tap Trust in the *Trust this computer* popup on the iOS 17 device. The *Trust this computer* prompts will reappear, tap *Trust* again. After this, there should be no more *Trust* prompts. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should this say iOS 17 here? It will be dated. Can you just say iOS device?
| Tap Trust in the *Trust this computer* popup on the iOS 17 device. The *Trust this computer* prompts will reappear, tap *Trust* again. After this, there should be no more *Trust* prompts. | ||
|
|
||
| In the Xcode menu bar, select **Window → Devices and Simulators**. Select the iOS 17 device under the **Devices** tab. | ||
| In the Xcode menu bar, select *Window → Devices and Simulators*. Select the iOS 17 device under the *Devices* tab. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
same comment about iOS 17 - can you just say iOS 17 device
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 3
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/modules/device-lab-management/pages/ios-devices/add-ios-device.adoc (1)
55-58: Fix logic: Lightning (iOS 17.4+) should not connect to Mac mini firstThis contradicts the dedicated “Lightning mode – iOS 17.4 and above” section (Lines 165–175), which correctly instructs trusting the GEM. Adjust here to prevent misconfiguration.
-For Lightning mode with iOS 16 and below, connect the mobile device to the Cambrionix hub attached to the GEM. - -For Lightning mode with iOS 17 and above, connect the device to one of the USB ports of the Mac mini host to establish trust pairing first, then follow the next section before connecting the device to the Cambrionix hub attached to the GEM. +For Lightning mode with iOS 16 and below, connect the mobile device to the Cambrionix hub attached to the GEM. + +For Lightning mode with iOS 17.0 to 17.3.1, connect the device to a USB port on the Mac mini host first to establish trust and complete symbol transfer. Then follow the next section before connecting the device to the Cambrionix hub attached to the GEM. + +For Lightning mode with iOS 17.4 and above, connect the device directly to the Cambrionix hub attached to the GEM.
🧹 Nitpick comments (8)
docs/modules/device-lab-management/pages/ios-devices/add-ios-device.adoc (8)
31-44: Network requirements section reads well; consider tightening prose for brevityThe guidance is accurate and aligns with mDNS/TCP pairing needs. Optional style edits below keep it concise without losing meaning.
-Prepare a network that satisfies the following requirements: +Prepare a network that satisfies the following requirements: -* _mDNS UDP Messages_: The devices will broadcast mDNS UDP messages that the Mac mini must be capable of receiving. This communication is facilitated via the UDP port 5353. +* _mDNS UDP messages_: Devices broadcast mDNS messages that the Mac mini must receive over UDP port 5353. -* _TCP Connection_: Processes housed on the Mac mini should have the capability to initiate a TCP connection to an iOS device. It's important to note that this connection uses one of the IPv6 addresses and port numbers that the device advertises. Since these addresses and port numbers aren't static and can change over time, flexibility in the network configuration is crucial. +* _TCP connection_: Processes on the Mac mini must be able to initiate a TCP connection to the iOS device using one of the IPv6 addresses and ports the device advertises. These values change over time; ensure the network allows this dynamic connectivity. -* _Optimal Setup_: The most straightforward way to implement this setup is by positioning both the Mac mini and the iOS devices on the same subnet within the same Wi-Fi network. Such an arrangement is compatible with the default configurations of a majority of network equipment, ensuring minimal overhead in terms of setup. However, if your network differs, adjustments can be made at the router level to support the necessary UDP broadcasts and TCP connections. +* _Optimal setup_: Place the Mac mini and iOS devices on the same Wi‑Fi subnet. Most networks support this by default. Otherwise, adjust routing to allow the UDP broadcasts and TCP connections above.
46-48: Spell out numerals in running textMinor style nit per Microsoft Style Guide.
-If the network requirements cannot be met, use *Standard mode* to host the iOS 17.0 to 17.3.1 devices instead. You will need at least 1 additional Mac mini to host in Standard mode. +If the network requirements cannot be met, use *Standard mode* to host the iOS 17.0 to 17.3.1 devices instead. You will need at least one additional Mac mini to host in Standard mode.
122-129: Standard Mode (iOS 17+): align UI capitalization and image alt text
- Capitalize “Trust This Computer”.
- Prefer “prompt” over “popup”.
- Clarify repeated-prompt phrasing.
-The device needs to be trusted by the Mac mini host it is plugged into. +The device needs to be trusted by the Mac mini host it is plugged into. -After plugging the device into the Mac mini host, open *Xcode* then navigate to *Window → Devices and Simulators*. Do this before continuing to the next step. +After plugging the device into the Mac mini host, open *Xcode*, then navigate to *Window → Devices and Simulators*. Do this before continuing to the next step. -When the *Trust this computer* prompt on the device screen appears, tap *Trust*. If the prompt reappears, tap *Trust* again until there is no more prompt. +When the *Trust This Computer* prompt appears on the device, tap *Trust*. If the prompt reappears, tap *Trust* again until it no longer appears. -image::device-lab-management:device-lab-management-ios-add-ios-standard-lightning-trust.PNG[width=300,alt="Standard Mode. Trust This Computer popup, clicking Trust"] +image::device-lab-management:device-lab-management-ios-add-ios-standard-lightning-trust.PNG[width=300,alt="Standard Mode. Trust This Computer prompt, tapping Trust"]
136-160: Lightning (iOS 17.0–17.3.1): improve clarity and fix plural agreement
- Clarify repeated-prompt phrasing.
- “In the Mac mini host’s screen” → “On the Mac mini host”.
- “icon next to it” → “icon next to its name”.
-When the *Trust this computer* prompt on the device screen appears, tap *Trust*. If the prompt reappears, tap *Trust* until there is no more prompt. +When the *Trust This Computer* prompt appears on the device, tap *Trust*. If the prompt reappears, tap *Trust* again until it no longer appears. -In the Mac mini host’s screen, under the *Devices* tab of the *Devices and Simulators* screen, the iOS 17 devices should show up with a yellow warning message like the one below: +On the Mac mini host, under the *Devices* tab of the *Devices and Simulators* window, the iOS 17 devices should appear with a yellow warning message like the one below: -The *Trust this computer* prompt will appear again to establish trust pairing with the GEM. Tap *Trust*. +The *Trust This Computer* prompt will appear again to establish trust pairing with the GEM. Tap *Trust*. -In Xcode’s _Devices and Simulators_, the iOS 17 devices will now have a globe icon next to it like below: +In Xcode’s *Devices and Simulators*, each iOS 17 device will now have a globe icon next to its name, as shown below:
181-181: Polish alt text capitalizationOptional: start with “Device” and add “the” before Kobiton for consistency.
-image::device-lab-management:device-lab-management-add-ios-screen-changes-to-blue.PNG[width=300, alt="device screen changes and shows Kobiton name and logo"] +image::device-lab-management:device-lab-management-add-ios-screen-changes-to-blue.PNG[width=300, alt="Device screen changes and shows the Kobiton name and logo"]
187-188: Tighten scope statement for air-gapped hostsSimplifies and removes ambiguity.
-This section is only required for Mac mini hosts with no Internet access with iOS 17 and above devices. +This section applies only to Mac mini hosts without Internet access that will host iOS 17 and above devices.
203-206: Unify capitalization and prompt language for DDI preload steps
- Capitalize “Trust This Computer”.
- Use “prompt” consistently.
- Clarify repeated-prompt phrasing.
-Tap Trust in the *Trust this computer* popup on the iOS device. The *Trust this computer* prompts will reappear, tap *Trust* again. After this, there should be no more *Trust* prompts. +Tap *Trust* in the *Trust This Computer* prompt on the iOS device. If the prompt reappears, tap *Trust* again until it no longer appears. -In the Xcode menu bar, select *Window → Devices and Simulators*. Select the iOS device under the *Devices* tab. +In the Xcode menu bar, select *Window → Devices and Simulators*. Select the iOS device under the *Devices* tab.
231-233: Grammar: past participle for expiration noteMinor clarity fix.
-Apple has not published whether the personalized DDI will expire or how long it will last in an air-gapped environment. If connection errors occur and other troubleshooting steps do not resolve the issue, the personalized DDI may be expired, and you will need to repeat this process. +Apple has not published whether the personalized DDI will expire or how long it will last in an air-gapped environment. If connection errors occur and other troubleshooting steps do not resolve the issue, the personalized DDI may have expired, and you will need to repeat this process.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
docs/modules/device-lab-management/pages/ios-devices/add-ios-device.adoc(5 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: publish-docs-test
- GitHub Check: Test Build
🔇 Additional comments (2)
docs/modules/device-lab-management/pages/ios-devices/add-ios-device.adoc (2)
165-175: Lightning mode (iOS 17.4+): LGTMWording, capitalization, and alt text align with earlier feedback. Flow is clear and accurate.
257-265: Device Management verification steps: LGTMFlow and terminology match current UI and roles.
| The device needs to be trusted by the system it is plugged into: | ||
|
|
||
| * For Lightning mode, that is the GEM (Dell server). | ||
| * For Standard mode, that is the Mac mini host. | ||
|
|
||
| After plugging the device to the appropriate system, check the device screen. Tap *Trust* on the *Trust this computer* popup: | ||
|
|
||
| image::device-lab-management:device-lab-management-ios-add-ios-trust-this-computer-trust.PNG[width=300,alt="Trust this computer popup, clicking Trust"] | ||
|
|
||
| Open **Finder** in the Mac mini host, select the connected device name, and choose **Trust**. | ||
| Open *Finder* in the Mac mini host, select the connected device name, and choose *Trust*. If the device appears in Finder but there is no _Trust_ button, skip this step. | ||
|
|
||
| image::device-lab-management:device-lab-management-ios-add-ios-trust-iphone-trust.PNG[width=600,alt="Trust this iphone window, clicking Trust"] | ||
|
|
||
| Unplug the device, then plug it in again. Wait until the device screen changes to the below before continuing (NOTE: there will also be an *automation running* overlay above the device screen): | ||
| Unplug the device, then plug it in again. Wait until the device screen changes as shown below before continuing. There will also be an *automation running* overlay above the device screen. | ||
|
|
||
| image::device-lab-management:device-lab-management-add-android-screen-changes-to-blue.PNG[width=300, alt="device screen changes and shows Kobiton name and logo"] | ||
| image::device-lab-management:device-lab-management-add-ios-screen-changes-to-blue.PNG[width=300, alt="device screen changes and shows Kobiton name and logo"] | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Standardize trust wording, capitalization, and platform phrasing (iOS 16 and below)
- “plugging the device to” → “into”.
- Use “Trust This Computer” consistently and call it a “prompt”.
- “Open Finder in the Mac mini host” → “on the Mac mini host”.
- Alt text: “iphone” → “iPhone”; “popup” → “prompt”.
-After plugging the device to the appropriate system, check the device screen. Tap *Trust* on the *Trust this computer* popup:
+After plugging the device into the appropriate system, check the device screen. Tap *Trust* on the *Trust This Computer* prompt:
-image::device-lab-management:device-lab-management-ios-add-ios-trust-this-computer-trust.PNG[width=300,alt="Trust this computer popup, clicking Trust"]
+image::device-lab-management:device-lab-management-ios-add-ios-trust-this-computer-trust.PNG[width=300,alt="Trust This Computer prompt, tapping Trust"]
-Open *Finder* in the Mac mini host, select the connected device name, and choose *Trust*. If the device appears in Finder but there is no _Trust_ button, skip this step.
+Open *Finder* on the Mac mini host, select the connected device name, and choose *Trust*. If the device appears in Finder but there is no *Trust* button, skip this step.
-image::device-lab-management:device-lab-management-ios-add-ios-trust-iphone-trust.PNG[width=600,alt="Trust this iphone window, clicking Trust"]
+image::device-lab-management:device-lab-management-ios-add-ios-trust-iphone-trust.PNG[width=600,alt="Trust this iPhone prompt, tapping Trust"]📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| The device needs to be trusted by the system it is plugged into: | |
| * For Lightning mode, that is the GEM (Dell server). | |
| * For Standard mode, that is the Mac mini host. | |
| After plugging the device to the appropriate system, check the device screen. Tap *Trust* on the *Trust this computer* popup: | |
| image::device-lab-management:device-lab-management-ios-add-ios-trust-this-computer-trust.PNG[width=300,alt="Trust this computer popup, clicking Trust"] | |
| Open **Finder** in the Mac mini host, select the connected device name, and choose **Trust**. | |
| Open *Finder* in the Mac mini host, select the connected device name, and choose *Trust*. If the device appears in Finder but there is no _Trust_ button, skip this step. | |
| image::device-lab-management:device-lab-management-ios-add-ios-trust-iphone-trust.PNG[width=600,alt="Trust this iphone window, clicking Trust"] | |
| Unplug the device, then plug it in again. Wait until the device screen changes to the below before continuing (NOTE: there will also be an *automation running* overlay above the device screen): | |
| Unplug the device, then plug it in again. Wait until the device screen changes as shown below before continuing. There will also be an *automation running* overlay above the device screen. | |
| image::device-lab-management:device-lab-management-add-android-screen-changes-to-blue.PNG[width=300, alt="device screen changes and shows Kobiton name and logo"] | |
| image::device-lab-management:device-lab-management-add-ios-screen-changes-to-blue.PNG[width=300, alt="device screen changes and shows Kobiton name and logo"] | |
| The device needs to be trusted by the system it is plugged into: | |
| * For Lightning mode, that is the GEM (Dell server). | |
| * For Standard mode, that is the Mac mini host. | |
| After plugging the device into the appropriate system, check the device screen. Tap *Trust* on the *Trust This Computer* prompt: | |
| image::device-lab-management:device-lab-management-ios-add-ios-trust-this-computer-trust.PNG[width=300,alt="Trust This Computer prompt, tapping Trust"] | |
| Open *Finder* on the Mac mini host, select the connected device name, and choose *Trust*. If the device appears in Finder but there is no *Trust* button, skip this step. | |
| image::device-lab-management:device-lab-management-ios-add-ios-trust-iphone-trust.PNG[width=600,alt="Trust this iPhone prompt, tapping Trust"] | |
| Unplug the device, then plug it in again. Wait until the device screen changes as shown below before continuing. There will also be an *automation running* overlay above the device screen. | |
| image::device-lab-management:device-lab-management-add-ios-screen-changes-to-blue.PNG[width=300,alt="device screen changes and shows Kobiton name and logo"] |
🤖 Prompt for AI Agents
In docs/modules/device-lab-management/pages/ios-devices/add-ios-device.adoc
around lines 83-99, standardize wording and capitalization: change “plugging the
device to” to “plugging the device into”; use “Trust This Computer” consistently
and refer to it as the “prompt” (replace “popup” with “prompt” and any lowercase
variants with the exact capitalization “Trust This Computer”); change “Open
Finder in the Mac mini host” to “Open Finder on the Mac mini host”; update alt
text to use “iPhone” (capitalized) and “prompt” instead of “popup”; ensure the
phrase “Trust” button/selection uses consistent capitalization and that any
parenthetical note about iOS 16 and below remains accurate.
| Copy the 2 files `iOS_DDI-version.plist` and `iOS_DDI.dmg` to the *air-gapped Mac mini* that will host the iOS devices. Put the copied file into the following folder on the air-gapped Mac mini: | ||
|
|
||
| * `/Library/Developer/DeveloperDiskImages` if the current Xcode version is 16 or above. | ||
|
|
||
| * ``~/Library/Developer/DeveloperDiskImages ``if the current Xcode version is below 16. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fix path formatting and numeral style; remove stray backticks/space
The double backticks and trailing space will render incorrectly; also spell out “two”.
-Copy the 2 files `iOS_DDI-version.plist` and `iOS_DDI.dmg` to the *air-gapped Mac mini* that will host the iOS devices. Put the copied file into the following folder on the air-gapped Mac mini:
+Copy the two files `iOS_DDI-version.plist` and `iOS_DDI.dmg` to the *air-gapped Mac mini* that will host the iOS devices. Put the copied files into the following folder on the air-gapped Mac mini:
* `/Library/Developer/DeveloperDiskImages` if the current Xcode version is 16 or above.
-* ``~/Library/Developer/DeveloperDiskImages ``if the current Xcode version is below 16.
+* `~/Library/Developer/DeveloperDiskImages` if the current Xcode version is below 16.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Copy the 2 files `iOS_DDI-version.plist` and `iOS_DDI.dmg` to the *air-gapped Mac mini* that will host the iOS devices. Put the copied file into the following folder on the air-gapped Mac mini: | |
| * `/Library/Developer/DeveloperDiskImages` if the current Xcode version is 16 or above. | |
| * ``~/Library/Developer/DeveloperDiskImages ``if the current Xcode version is below 16. | |
| Copy the two files `iOS_DDI-version.plist` and `iOS_DDI.dmg` to the *air-gapped Mac mini* that will host the iOS devices. Put the copied files into the following folder on the air-gapped Mac mini: | |
| * `/Library/Developer/DeveloperDiskImages` if the current Xcode version is 16 or above. | |
| * `~/Library/Developer/DeveloperDiskImages` if the current Xcode version is below 16. |
🤖 Prompt for AI Agents
In docs/modules/device-lab-management/pages/ios-devices/add-ios-device.adoc
around lines 221–225, replace the current text that uses double backticks, a
trailing space, and a numeral with a clean sentence: spell out “two”, remove the
stray backticks/trailing space, and format the folder paths in code style; e.g.
"Copy the two files iOS_DDI-version.plist and iOS_DDI.dmg to the air-gapped Mac
mini that will host the iOS devices. Place the copied files into
/Library/Developer/DeveloperDiskImages if the current Xcode version is 16 or
above, or into ~/Library/Developer/DeveloperDiskImages if the current Xcode
version is below 16."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Check the above comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@erincbailey I've reviewed the comment above. The CodeRabbit bot correctly identified several formatting issues in the text:
- Double backticks with trailing space: Line 225 has
~/Library/Developer/DeveloperDiskImageswhich should be~/Library/Developer/DeveloperDiskImages - Numeral usage: "2 files" should be spelled out as "two files" per documentation style guidelines
- Singular vs plural: "Put the copied file" should be "Put the copied files" since there are two files being copied
The suggested fix is valid and will improve the documentation's formatting and readability. I recommend applying this change.
| Navigate to *Devices*. The connected device displays as *Available*. | ||
|
|
||
| image::device-lab-management:device-lab-management-ios-add-ios-localhost-system-ios-device-available.PNG[width=600,alt="Verifying device is avaiable on Kobiton"] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fix misspelling in image alt text (“avaiable” → “available”)
Typo in user-facing documentation.
-image::device-lab-management:device-lab-management-ios-add-ios-localhost-system-ios-device-available.PNG[width=600,alt="Verifying device is avaiable on Kobiton"]
+image::device-lab-management:device-lab-management-ios-add-ios-localhost-system-ios-device-available.PNG[width=600,alt="Verifying device is available on Kobiton"]📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Navigate to *Devices*. The connected device displays as *Available*. | |
| image::device-lab-management:device-lab-management-ios-add-ios-localhost-system-ios-device-available.PNG[width=600,alt="Verifying device is avaiable on Kobiton"] | |
| Navigate to *Devices*. The connected device displays as *Available*. | |
| image::device-lab-management:device-lab-management-ios-add-ios-localhost-system-ios-device-available.PNG[width=600,alt="Verifying device is available on Kobiton"] |
🤖 Prompt for AI Agents
In docs/modules/device-lab-management/pages/ios-devices/add-ios-device.adoc
around lines 239 to 241, the image alt text contains a typo ("avaiable"); update
the alt attribute in the image macro from alt="Verifying device is avaiable on
Kobiton" to alt="Verifying device is available on Kobiton" so the user-facing
documentation reads correctly.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
make this change
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@erincbailey, great! The typo fix will improve the documentation's professionalism. The change from "avaiable" to "available" in the image alt text is straightforward and will ensure the accessibility text is correct for screen readers and other assistive technologies. 👍
If you found this review helpful, would you consider giving us a shout-out on X?
Thank you for using CodeRabbit!
erincbailey
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
a few minor changes and agree with coderabbit. Please publish without my needing to review again.
| After plugging the device into the Mac mini host, open *Xcode* then navigate to *Window → Devices and Simulators*. Do this before continuing to the next step. | ||
| image::device-lab-management:device-lab-management-ios-add-ios-standard-lightning-trust.PNG[width=300,alt="Standard Mode. Trust This Computer popup, clicking Trust"] | ||
| When the *Trust this computer* prompt on the device screen appears, tap *Trust*. If the prompt reappears, tap *Trust* again until there is no more prompt. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Update end - "until there are no more prompts."
| The device needs to be trusted by both of the following: | ||
| Open Xcode on the Mac mini host, then navigate to **Window → Devices and Simulators**. Do this before continuing to the next step. | ||
| * The Mac mini host that is paired with the GEM (Dell server) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Did you reverify?
| Open Xcode on the Mac mini host, then navigate to *Window → Devices and Simulators*. Do this before continuing to the next step. | ||
| When the *Trust this computer* prompt on the device screen appears, tap *Trust*. If the prompt reappears, tap *Trust* until there is no more prompt. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"until there are no more prompts."
| Copy the 2 files `iOS_DDI-version.plist` and `iOS_DDI.dmg` to the *air-gapped Mac mini* that will host the iOS devices. Put the copied file into the following folder on the air-gapped Mac mini: | ||
|
|
||
| * `/Library/Developer/DeveloperDiskImages` if the current Xcode version is 16 or above. | ||
|
|
||
| * ``~/Library/Developer/DeveloperDiskImages ``if the current Xcode version is below 16. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Check the above comment
| Navigate to *Devices*. The connected device displays as *Available*. | ||
|
|
||
| image::device-lab-management:device-lab-management-ios-add-ios-localhost-system-ios-device-available.PNG[width=600,alt="Verifying device is avaiable on Kobiton"] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
make this change
Summary
Related PRs, issues, or features (optional)
Metadata
PR contributor checklist
My PR follows the Kobiton Docs contributor guidelines, meaning:
nav.adocfile.en-us) from my URLs.Summary by CodeRabbit