Adding new docs inspector #372
Conversation
|
Important Review skippedReview was skipped due to path filters ⛔ Files ignored due to path filters (11)
CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including You can disable this status message by setting the WalkthroughThe updates introduce a new "Appium Tools" navigation section and a comprehensive guide for connecting Appium Inspector to Kobiton. Documentation for the Inspector tool was extensively rewritten for clarity and detail. Several images were enlarged for better visibility, credential instructions for launching Appium 2 sessions were clarified and expanded, and a broken image link was fixed. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Appium Inspector
participant Kobiton Server
User->>Appium Inspector: Launch Appium Inspector
User->>Appium Inspector: Enter Kobiton credentials & server details
Appium Inspector->>Kobiton Server: Connect using credentials
Kobiton Server-->>Appium Inspector: Authenticate and respond
User->>Appium Inspector: Input device and session capabilities (JSON)
Appium Inspector->>Kobiton Server: Start session with capabilities
Kobiton Server-->>Appium Inspector: Session started, device ready
User->>Appium Inspector: Inspect and interact with device session
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (3)
docs/modules/session-explorer/pages/analytics/reinspect-appium-elements.adoc (1)
20-55: Verify 1000-px images won’t blow out responsive layoutBumping every screenshot to a fixed
width=1000may cause horizontal scrolling on small-viewport devices. Consider using a percentage (width=100%) or omitting the width so Antora/Asciidoctor scales the image automatically.docs/modules/automation-testing/pages/basic-appium-server/launch-a-basic-appium-2-session.adoc (2)
25-88: Data-type accuracy forkobiton:retainDurationInSecondsThe table lists the type as String, but the capability represents a numeric duration. Marking it as Integer (or “Number”) avoids confusion and keeps examples consistent with other docs.
-|`kobiton:retainDurationInSeconds` -|String +|`kobiton:retainDurationInSeconds` +|Integer
98-111: Example uses Android “15” (rumoured release)Android 15 is still in preview; customers on production devices may fail to match this version string. Swapping to “14” or clearly flagging it as preview will reduce support noise.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (15)
docs/modules/automation-testing/images/appium-inspector-capabilities.pngis excluded by!**/*.pngdocs/modules/session-explorer/images/appium-inspector-context.pngis excluded by!**/*.pngdocs/modules/session-explorer/images/appium-inspector-select-element.pngis excluded by!**/*.pngdocs/modules/session-explorer/images/attributes-context-one.pngis excluded by!**/*.pngdocs/modules/session-explorer/images/attributes-context-two.pngis excluded by!**/*.pngdocs/modules/session-explorer/images/attributes-context.pngis excluded by!**/*.pngdocs/modules/session-explorer/images/download-inventory-context.pngis excluded by!**/*.pngdocs/modules/session-explorer/images/hover-attribute-closeup.pngis excluded by!**/*.pngdocs/modules/session-explorer/images/inspect-elements-context.pngis excluded by!**/*.pngdocs/modules/session-explorer/images/refresh-inventory-closeup.pngis excluded by!**/*.pngdocs/modules/session-explorer/images/search-bar-closeup.pngis excluded by!**/*.pngdocs/modules/session-explorer/images/search-session-id-closeup.pngis excluded by!**/*.pngdocs/modules/session-explorer/images/select-explorer-context.pngis excluded by!**/*.pngdocs/modules/session-explorer/images/select-sessions-closeup.pngis excluded by!**/*.pngdocs/modules/session-explorer/images/webview-closeup.pngis excluded by!**/*.png
📒 Files selected for processing (5)
docs/modules/automation-testing/nav.adoc(1 hunks)docs/modules/automation-testing/pages/basic-appium-server/launch-a-basic-appium-2-session.adoc(1 hunks)docs/modules/automation-testing/pages/connect-appium-to-kobiton.adoc(1 hunks)docs/modules/manual-testing/pages/device-information/inspector.adoc(1 hunks)docs/modules/session-explorer/pages/analytics/reinspect-appium-elements.adoc(3 hunks)
🧰 Additional context used
🧠 Learnings (5)
📓 Common learnings
Learnt from: tungmhoang
PR: kobiton/docs#277
File: docs/modules/automation-testing/pages/get-a-session-id/using-the-kobiton-portal.adoc:16-16
Timestamp: 2025-06-05T04:25:21.053Z
Learning: In Kobiton documentation, "Session Overview" terminology is still appropriate when referring to the overview section/view within Session Explorer, even when other parts of the documentation use "Session Explorer" terminology.
docs/modules/session-explorer/pages/analytics/reinspect-appium-elements.adoc (1)
Learnt from: tungmhoang
PR: kobiton/docs#277
File: docs/modules/automation-testing/pages/get-a-session-id/using-the-kobiton-portal.adoc:16-16
Timestamp: 2025-06-05T04:25:21.053Z
Learning: In Kobiton documentation, "Session Overview" terminology is still appropriate when referring to the overview section/view within Session Explorer, even when other parts of the documentation use "Session Explorer" terminology.
docs/modules/manual-testing/pages/device-information/inspector.adoc (1)
Learnt from: tungmhoang
PR: kobiton/docs#277
File: docs/modules/automation-testing/pages/get-a-session-id/using-the-kobiton-portal.adoc:16-16
Timestamp: 2025-06-05T04:25:21.053Z
Learning: In Kobiton documentation, "Session Overview" terminology is still appropriate when referring to the overview section/view within Session Explorer, even when other parts of the documentation use "Session Explorer" terminology.
docs/modules/automation-testing/pages/basic-appium-server/launch-a-basic-appium-2-session.adoc (1)
Learnt from: tungmhoang
PR: kobiton/docs#277
File: docs/modules/automation-testing/pages/get-a-session-id/using-the-kobiton-portal.adoc:16-16
Timestamp: 2025-06-05T04:25:21.053Z
Learning: In Kobiton documentation, "Session Overview" terminology is still appropriate when referring to the overview section/view within Session Explorer, even when other parts of the documentation use "Session Explorer" terminology.
docs/modules/automation-testing/pages/connect-appium-to-kobiton.adoc (1)
Learnt from: tungmhoang
PR: kobiton/docs#277
File: docs/modules/automation-testing/pages/get-a-session-id/using-the-kobiton-portal.adoc:16-16
Timestamp: 2025-06-05T04:25:21.053Z
Learning: In Kobiton documentation, "Session Overview" terminology is still appropriate when referring to the overview section/view within Session Explorer, even when other parts of the documentation use "Session Explorer" terminology.
🔇 Additional comments (1)
docs/modules/automation-testing/nav.adoc (1)
2-2: Navigation entry LGTMThe new link is correctly formatted and positioned logically in the list.
docs/modules/automation-testing/pages/connect-appium-to-kobiton.adoc
Outdated
Show resolved
Hide resolved
docs/modules/automation-testing/pages/connect-appium-to-kobiton.adoc
Outdated
Show resolved
Hide resolved
docs/modules/manual-testing/pages/device-information/inspector.adoc
Outdated
Show resolved
Hide resolved
tungmhoang
left a comment
tungmhoang
left a comment
There was a problem hiding this comment.
@edgarysabel Some comments regarding images.
|
Also, @edgarysabel please clone this repo to your local machine and create a new branch on the official repo, instead of forking your own. |
|
@tungmhoang Making a new branch in the main repo is not allowed to me, I can do if given the permission. Will be working in this fork! |
tungmhoang
left a comment
tungmhoang
left a comment
There was a problem hiding this comment.
More changes that need to be made.
docs/modules/automation-testing/pages/connect-appium-to-kobiton.adoc
Outdated
Show resolved
Hide resolved
docs/modules/session-explorer/images/appium-inspector-select-element.png
Show resolved
Hide resolved
docs/modules/session-explorer/images/download-inventory-contex.jpeg
Outdated
Show resolved
Hide resolved
docs/modules/automation-testing/pages/basic-appium-server/launch-a-basic-appium-2-session.adoc
Outdated
Show resolved
Hide resolved
docs/modules/automation-testing/pages/basic-appium-server/launch-a-basic-appium-2-session.adoc
Outdated
Show resolved
Hide resolved
docs/modules/automation-testing/pages/connect-appium-to-kobiton.adoc
Outdated
Show resolved
Hide resolved
It's okay. You can work in this fork. |
docs/modules/automation-testing/pages/connect-appium-to-kobiton.adoc
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (5)
docs/modules/automation-testing/pages/connect-appium-inspector-to-kobiton.adoc (5)
41-47: Fix bold-code formatting in the On-Prem “Remote host” bulletThe current text has an extra space between the two asterisks (
**kobitonServerUrl **value) which breaks bold rendering and looks like a typo.-*** *Remote host*: fill in the address of the Portal server. You can find this information from the **kobitonServerUrl **value in Automation Settings. Example: `192.168.50.85` or `www.kobiton.local`. +*** *Remote host*: fill in the address of the Portal server. You can find this information from the **`kobitonServerUrl`** value in *Automation Settings*. Example: `192.168.50.85` or `www.kobiton.local`.
55-57: Back-tick and quote mismatch in capability list
appium:accessKeyis missing the closing back-tick, and both keys should be styled consistently.-**`"appium:username"`: the Kobiton account’s username. -** `"appium:accessKey`: the Kobiton account’s API key. +** `appium:username`: the Kobiton account’s username. +** `appium:accessKey`: the Kobiton account’s API key.
61-68: Replace smart quotes and align capability formattingSmart quotes (
“ ”) will be rendered literally in AsciiDoc and break JSON copy-paste. Use straight quotes and back-ticks for inline code.-** `“kobiton:runtime"`:"appium". -** `"appium:automationName"`: must have one of the below values: +** `kobiton:runtime`: `"appium"` +** `appium:automationName`: must have one of the values below:Also consider moving the code value (
"appium") outside the bullet title for clearer reading, as shown above.
74-85: Minor JSON hygieneIncluding a
vendorPrefix:on standard capabilities is fine, but for completeness consider adding the authentication keys (appium:username,appium:accessKey) to the Xium example so readers can copy-paste directly.No functional issue—only a documentation enhancement.
125-129: Anchor the “Android” subsection for quicker linkingIf this page grows, an explicit anchor (e.g.
[id="android-workarounds"]) before*Android*:will let other docs deep-link to it.Not required, but improves long-term maintainability of cross-references.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
docs/modules/automation-testing/nav.adoc(1 hunks)docs/modules/automation-testing/pages/basic-appium-server/launch-a-basic-appium-2-session.adoc(1 hunks)docs/modules/automation-testing/pages/connect-appium-inspector-to-kobiton.adoc(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
- docs/modules/automation-testing/nav.adoc
- docs/modules/automation-testing/pages/basic-appium-server/launch-a-basic-appium-2-session.adoc
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: tungmhoang
PR: kobiton/docs#277
File: docs/modules/automation-testing/pages/get-a-session-id/using-the-kobiton-portal.adoc:16-16
Timestamp: 2025-06-05T04:25:21.053Z
Learning: In Kobiton documentation, "Session Overview" terminology is still appropriate when referring to the overview section/view within Session Explorer, even when other parts of the documentation use "Session Explorer" terminology.
docs/modules/automation-testing/pages/connect-appium-inspector-to-kobiton.adoc (1)
Learnt from: tungmhoang
PR: kobiton/docs#277
File: docs/modules/automation-testing/pages/get-a-session-id/using-the-kobiton-portal.adoc:16-16
Timestamp: 2025-06-05T04:25:21.053Z
Learning: In Kobiton documentation, "Session Overview" terminology is still appropriate when referring to the overview section/view within Session Explorer, even when other parts of the documentation use "Session Explorer" terminology.
|
@erincbailey could you review this as well? |
3 participants
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