Skip to content

Conversation

@tiffany-kobiton
Copy link
Contributor

@tiffany-kobiton tiffany-kobiton commented Dec 15, 2025

Summary

  • Add UiPath integration guide.

Related PRs, issues, or features (optional)

  • KOB-51615

Metadata

  • Adds new file(s)
  • Edits existing file(s)
  • Removes file(s)

PR contributor checklist

Summary by CodeRabbit

  • Documentation
    • Added a UiPath Mobile Automation integration guide and new navigation entry. The guide provides step‑by‑step instructions for prerequisites and environment setup, device and app configuration, connecting and recording actions, importing recordings into UiPath, creating and running tests, logging and validation, and proper device disconnection to free resources.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link

coderabbitai bot commented Dec 15, 2025

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

Walkthrough

Adds a new UiPath integration AsciiDoc page and a navigation entry under integrations documenting end-to-end mobile automation with UiPath Studio using Kobiton devices.

Changes

Cohort / File(s) Summary
Integrations navigation
docs/modules/integrations/nav.adoc
Added a new navigation entry for the UiPath integration.
UiPath mobile automation docs
docs/modules/integrations/pages/uipath/mobile-test-uipath.adoc
Added a comprehensive guide covering prerequisites, environment setup, Mobile Automation package (v24.10.0+), device and app capability configuration (e.g., udid, kobiton:username, kobiton:accessKey, kobiton:runtime), connecting/recording with devices, importing recorded actions into UiPath projects, creating/executing tests, logging/screenshots, and disconnection/cleanup instructions.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10–15 minutes

  • Verify AsciiDoc syntax, image/link paths, and internal cross-links in mobile-test-uipath.adoc
  • Confirm nav insertion and path correctness in nav.adoc
  • Ensure no example credentials or sensitive values are included

Possibly related PRs

  • Katalon integration #379 — Adds an integration documentation page and updates docs/modules/integrations/nav.adoc (similar nav-area addition).
  • Tosca integration #370 — Adds a different integration guide and updates docs/modules/integrations/nav.adoc (related navigation modification).

Suggested reviewers

  • erincbailey

Poem

🐰 I hopped through files, soft and spry,
Placed UiPath footsteps, neat and spry,
Devices paired, recordings hum,
Keys tucked safe — the tests will run,
A joyful hop — automation, hi!

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Add UiPath doc to Integrations section' accurately and specifically describes the main change: adding a new UiPath documentation file to the Integrations section.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch add-uipath

📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f741d09 and 3da9591.

📒 Files selected for processing (1)
  • docs/modules/integrations/pages/uipath/mobile-test-uipath.adoc (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/modules/integrations/pages/uipath/mobile-test-uipath.adoc
⏰ 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: Test Build
  • GitHub Check: publish-docs-test

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a 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/integrations/pages/uipath/mobile-test-uipath.adoc (4)

16-28: Consider using local section links instead of Confluence anchors

The “Contents” list links out to specific anchors in the Confluence page, while the same sections exist locally on this page. That can create drift if one source is updated without the other.

Consider switching these to local xrefs/anchors so the ToC always points at the content in this page. For example:

-* https://kobiton.atlassian.net/...#Prerequisites[Prerequisites] +
+* <<_prerequisites,Prerequisites>> +

(and similar for the other sections).


56-58: Tighten wording and verify minimum UiPath package version

Minor copy edit and a quick check request for the dependency version:

  • “Ensure the selected version to install is…” reads a bit awkwardly.

You can simplify to:

-In the search bar, enter *UiPath.MobileAutomation.Activities*. Select
-the package and choose *Install*. Ensure the selected version to install
-is 24.10.0 or later.
+In the search bar, enter *UiPath.MobileAutomation.Activities*. Select
+the package and choose *Install*. Ensure the selected version is
+24.10.0 or later.

Also, please confirm against UiPath’s latest docs that 24.10.0 is still the correct minimum version to call out here.


74-76: Verify {plus} macro usage for the icon name

The phrase “plus ({plus}) icon” relies on {plus} being defined as an attribute. If that attribute isn’t configured globally, it may render literally instead of as +.

You could avoid that dependency with:

-In the Mobile Device Manager window, select *Open Devices*, then the
-*plus ({plus}) icon* to create a new device connection.
+In the Mobile Device Manager window, select *Open Devices*, then the
+*plus (+) icon* to create a new device connection.

Same pattern applies later for the application “plus” icon.


219-221: Fix minor grammar in debug description

Tiny grammar nit: singular subject with plural verb.

-If *Debug File* is selected, the Debug window appears while Mobile
-Device Manager opens a new connection to the device and execute the
-test.
+If *Debug File* is selected, the Debug window appears while Mobile
+Device Manager opens a new connection to the device and executes the
+test.
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 781d3ac and f022e6d.

⛔ Files ignored due to path filters (24)
  • docs/modules/integrations/images/uipath-img0000.png is excluded by !**/*.png
  • docs/modules/integrations/images/uipath-img00000.png is excluded by !**/*.png
  • docs/modules/integrations/images/uipath-img01.png is excluded by !**/*.png
  • docs/modules/integrations/images/uipath-img02.png is excluded by !**/*.png
  • docs/modules/integrations/images/uipath-img03.png is excluded by !**/*.png
  • docs/modules/integrations/images/uipath-img04.png is excluded by !**/*.png
  • docs/modules/integrations/images/uipath-img05.png is excluded by !**/*.png
  • docs/modules/integrations/images/uipath-img06.png is excluded by !**/*.png
  • docs/modules/integrations/images/uipath-img07.png is excluded by !**/*.png
  • docs/modules/integrations/images/uipath-img08.png is excluded by !**/*.png
  • docs/modules/integrations/images/uipath-img09.png is excluded by !**/*.png
  • docs/modules/integrations/images/uipath-img10.png is excluded by !**/*.png
  • docs/modules/integrations/images/uipath-img11.png is excluded by !**/*.png
  • docs/modules/integrations/images/uipath-img12.png is excluded by !**/*.png
  • docs/modules/integrations/images/uipath-img13.png is excluded by !**/*.png
  • docs/modules/integrations/images/uipath-img14.png is excluded by !**/*.png
  • docs/modules/integrations/images/uipath-img15.png is excluded by !**/*.png
  • docs/modules/integrations/images/uipath-img16.png is excluded by !**/*.png
  • docs/modules/integrations/images/uipath-img17.png is excluded by !**/*.png
  • docs/modules/integrations/images/uipath-img18.png is excluded by !**/*.png
  • docs/modules/integrations/images/uipath-img19.png is excluded by !**/*.png
  • docs/modules/integrations/images/uipath-img20.png is excluded by !**/*.png
  • docs/modules/integrations/images/uipath-img21.png is excluded by !**/*.png
  • docs/modules/integrations/images/uipath-img22.png is excluded by !**/*.png
📒 Files selected for processing (2)
  • docs/modules/integrations/nav.adoc (1 hunks)
  • docs/modules/integrations/pages/uipath/mobile-test-uipath.adoc (1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: tungmhoang
Repo: kobiton/docs PR: 392
File: docs/modules/release-notes/pages/all-releases/4_22.adoc:26-26
Timestamp: 2025-11-26T08:47:40.925Z
Learning: In Kobiton release notes (docs/modules/release-notes/pages/all-releases/*.adoc), it is acceptable to include placeholder text stating that user guides or documentation "will be available soon" when the feature is released but documentation is still in progress.
📚 Learning: 2025-11-26T08:47:40.925Z
Learnt from: tungmhoang
Repo: kobiton/docs PR: 392
File: docs/modules/release-notes/pages/all-releases/4_22.adoc:26-26
Timestamp: 2025-11-26T08:47:40.925Z
Learning: In Kobiton release notes (docs/modules/release-notes/pages/all-releases/*.adoc), it is acceptable to include placeholder text stating that user guides or documentation "will be available soon" when the feature is released but documentation is still in progress.

Applied to files:

  • docs/modules/integrations/pages/uipath/mobile-test-uipath.adoc
⏰ 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 (1)
docs/modules/integrations/nav.adoc (1)

49-50: UiPath nav entry looks consistent and correct

The new UiPath entry follows the existing xref pattern and is placed logically alongside other integrations. No issues from a structure or naming standpoint.

Copy link
Collaborator

@tungmhoang tungmhoang left a comment

Choose a reason for hiding this comment

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

@tiffany-kobiton I have a few comments that need changes.

@kobiton kobiton deleted a comment from coderabbitai bot Dec 16, 2025
@kobiton kobiton deleted a comment from coderabbitai bot Dec 16, 2025
Copy link
Collaborator

@tungmhoang tungmhoang left a comment

Choose a reason for hiding this comment

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

Some more change requests.

Copy link
Collaborator

@tungmhoang tungmhoang left a comment

Choose a reason for hiding this comment

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

More comments regarding image size

@tiffany-kobiton
Copy link
Contributor Author

Requested changes made (conversations marked as resolved). Posted some questions on the Confluence doc.

@tungmhoang
Copy link
Collaborator

@tiffany-kobiton I have udpated the Confluence doc based on your comment. Please update this PR with the latest changes after you have reviewed the Confluence doc and had no more feedbacks.

@tungmhoang
Copy link
Collaborator

Also, @tiffany-kobiton looks like you have not pushed your local commit, so I cannot see the changes.

@tiffany-kobiton
Copy link
Contributor Author

tiffany-kobiton commented Dec 17, 2025 via email

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f022e6d and ca7f087.

⛔ Files ignored due to path filters (25)
  • docs/modules/integrations/images/uipath-add-a-device.png is excluded by !**/*.png
  • docs/modules/integrations/images/uipath-add-application-app.png is excluded by !**/*.png
  • docs/modules/integrations/images/uipath-add-application-web.png is excluded by !**/*.png
  • docs/modules/integrations/images/uipath-add-new-activity.png is excluded by !**/*.png
  • docs/modules/integrations/images/uipath-connection-details.png is excluded by !**/*.png
  • docs/modules/integrations/images/uipath-create-connection.png is excluded by !**/*.png
  • docs/modules/integrations/images/uipath-debug-activity-indicator.png is excluded by !**/*.png
  • docs/modules/integrations/images/uipath-design-debug-ribbon-item.png is excluded by !**/*.png
  • docs/modules/integrations/images/uipath-live-device-with-x.png is excluded by !**/*.png
  • docs/modules/integrations/images/uipath-logging-enabled.png is excluded by !**/*.png
  • docs/modules/integrations/images/uipath-main-activity-indicators.png is excluded by !**/*.png
  • docs/modules/integrations/images/uipath-main-window.png is excluded by !**/*.png
  • docs/modules/integrations/images/uipath-manage-packages.png is excluded by !**/*.png
  • docs/modules/integrations/images/uipath-mobile-automation-activities-v24.png is excluded by !**/*.png
  • docs/modules/integrations/images/uipath-mobile-automation-activities.png is excluded by !**/*.png
  • docs/modules/integrations/images/uipath-mobile-automation-menu.png is excluded by !**/*.png
  • docs/modules/integrations/images/uipath-mobile-device-connection-window.png is excluded by !**/*.png
  • docs/modules/integrations/images/uipath-mobile-device-manager-applications-window.png is excluded by !**/*.png
  • docs/modules/integrations/images/uipath-mobile-device-manager-live.png is excluded by !**/*.png
  • docs/modules/integrations/images/uipath-mobile-device-manager-welcome-again.png is excluded by !**/*.png
  • docs/modules/integrations/images/uipath-mobile-device-manager-welcome.png is excluded by !**/*.png
  • docs/modules/integrations/images/uipath-mobile-device-recorded-sessions.png is excluded by !**/*.png
  • docs/modules/integrations/images/uipath-mobile-device-search.png is excluded by !**/*.png
  • docs/modules/integrations/images/uipath-mobile-test-mobile-automation.png is excluded by !**/*.png
  • docs/modules/integrations/images/uipath-mobile-test-properties.png is excluded by !**/*.png
📒 Files selected for processing (1)
  • docs/modules/integrations/pages/uipath/mobile-test-uipath.adoc (1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: 2025-11-26T08:47:40.925Z
Learnt from: tungmhoang
Repo: kobiton/docs PR: 392
File: docs/modules/release-notes/pages/all-releases/4_22.adoc:26-26
Timestamp: 2025-11-26T08:47:40.925Z
Learning: In Kobiton release notes (docs/modules/release-notes/pages/all-releases/*.adoc), it is acceptable to include placeholder text stating that user guides or documentation "will be available soon" when the feature is released but documentation is still in progress.

Applied to files:

  • docs/modules/integrations/pages/uipath/mobile-test-uipath.adoc
📚 Learning: 2025-12-16T07:27:41.117Z
Learnt from: tungmhoang
Repo: kobiton/docs PR: 395
File: docs/modules/integrations/pages/uipath/mobile-test-uipath.adoc:11-15
Timestamp: 2025-12-16T07:27:41.117Z
Learning: For all documentation files under docs/modules/integrations/pages/ (and its subdirectories) that reference platform version requirements for device support, use 'Kobiton' as the product name (not 'Portal') and express versions without the trailing 'S'. Example: 'Kobiton 4.19.6 and above' instead of 'Portal 4.19.6S and above'.

Applied to files:

  • docs/modules/integrations/pages/uipath/mobile-test-uipath.adoc
⏰ 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: Test Build
  • GitHub Check: publish-docs-test

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

♻️ Duplicate comments (1)
docs/modules/integrations/pages/uipath/mobile-test-uipath.adoc (1)

14-14: Remove trailing 'S' from version numbers to align with documentation standards.

Lines 14 and 24 reference versions with the 'S' suffix (e.g., "4.21.1S"), but the documentation guideline specifies expressing versions without the trailing 'S'. Update to use "Kobiton 4.21.1" (removing "4.21.1S").

Per learnings, versions should be expressed consistently without the 'S' suffix (e.g., 'Kobiton 4.21.1 and above' instead of 'Kobiton 4.21.1S and above').

🔎 Proposed fixes
- * Android devices (Kobiton 4.21.1 and newer, including 4.21.1S).
+ * Android devices (Kobiton 4.21.1 and newer).
- * If you are working with Android devices, verify that your Kobiton version is 4.21.1, 4.21.1S, or newer.
+ * If you are working with Android devices, verify that your Kobiton version is 4.21.1 or newer.

Also applies to: 24-24

📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3303b05 and 5a829eb.

📒 Files selected for processing (1)
  • docs/modules/integrations/pages/uipath/mobile-test-uipath.adoc (1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: 2025-11-26T08:47:40.925Z
Learnt from: tungmhoang
Repo: kobiton/docs PR: 392
File: docs/modules/release-notes/pages/all-releases/4_22.adoc:26-26
Timestamp: 2025-11-26T08:47:40.925Z
Learning: In Kobiton release notes (docs/modules/release-notes/pages/all-releases/*.adoc), it is acceptable to include placeholder text stating that user guides or documentation "will be available soon" when the feature is released but documentation is still in progress.

Applied to files:

  • docs/modules/integrations/pages/uipath/mobile-test-uipath.adoc
📚 Learning: 2025-12-16T07:27:41.117Z
Learnt from: tungmhoang
Repo: kobiton/docs PR: 395
File: docs/modules/integrations/pages/uipath/mobile-test-uipath.adoc:11-15
Timestamp: 2025-12-16T07:27:41.117Z
Learning: For all documentation files under docs/modules/integrations/pages/ (and its subdirectories) that reference platform version requirements for device support, use 'Kobiton' as the product name (not 'Portal') and express versions without the trailing 'S'. Example: 'Kobiton 4.19.6 and above' instead of 'Portal 4.19.6S and above'.

Applied to files:

  • docs/modules/integrations/pages/uipath/mobile-test-uipath.adoc
⏰ 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: Test Build
  • GitHub Check: publish-docs-test

Copy link

@coderabbitai coderabbitai bot left a 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

📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5a829eb and f741d09.

📒 Files selected for processing (1)
  • docs/modules/integrations/pages/uipath/mobile-test-uipath.adoc (1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: 2025-11-26T08:47:40.925Z
Learnt from: tungmhoang
Repo: kobiton/docs PR: 392
File: docs/modules/release-notes/pages/all-releases/4_22.adoc:26-26
Timestamp: 2025-11-26T08:47:40.925Z
Learning: In Kobiton release notes (docs/modules/release-notes/pages/all-releases/*.adoc), it is acceptable to include placeholder text stating that user guides or documentation "will be available soon" when the feature is released but documentation is still in progress.

Applied to files:

  • docs/modules/integrations/pages/uipath/mobile-test-uipath.adoc
📚 Learning: 2025-12-16T07:27:41.117Z
Learnt from: tungmhoang
Repo: kobiton/docs PR: 395
File: docs/modules/integrations/pages/uipath/mobile-test-uipath.adoc:11-15
Timestamp: 2025-12-16T07:27:41.117Z
Learning: For all documentation files under docs/modules/integrations/pages/ (and its subdirectories) that reference platform version requirements for device support, use 'Kobiton' as the product name (not 'Portal') and express versions without the trailing 'S'. Example: 'Kobiton 4.19.6 and above' instead of 'Portal 4.19.6S and above'.

Applied to files:

  • docs/modules/integrations/pages/uipath/mobile-test-uipath.adoc
⏰ 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 (1)
docs/modules/integrations/pages/uipath/mobile-test-uipath.adoc (1)

93-93: Verify xref syntax with window=read-later attribute on line 93.

Line 93 combines an internal xref link with the window=read-later attribute, which is typically reserved for external HTTP links. Verify whether this syntax is valid in Antora or if the attribute should be removed from the internal reference.

** App Repo ID for apps xref:apps:upload-an-app/using-the-kobiton-portal.adoc[uploaded,window=read-later] to the Kobiton App Repo.

If window=read-later should not be used with xref, remove it:

-** App Repo ID for apps xref:apps:upload-an-app/using-the-kobiton-portal.adoc[uploaded,window=read-later] to the Kobiton App Repo.
+** App Repo ID for apps xref:apps:upload-an-app/using-the-kobiton-portal.adoc[uploaded] to the Kobiton App Repo.

Copy link
Collaborator

@tungmhoang tungmhoang left a comment

Choose a reason for hiding this comment

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

I made some change myself and approved.

@tungmhoang tungmhoang merged commit f8258c3 into main Dec 19, 2025
4 checks passed
@tungmhoang tungmhoang deleted the add-uipath branch December 19, 2025 14:22
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