Skip to content

test case doc#28

Open
arshadarsh99 wants to merge 4 commits intomainfrom
test-case-doc
Open

test case doc#28
arshadarsh99 wants to merge 4 commits intomainfrom
test-case-doc

Conversation

@arshadarsh99
Copy link
Collaborator

@arshadarsh99 arshadarsh99 commented Feb 4, 2026

Summary by CodeRabbit

  • Documentation

    • Reworked test-case guides into concise, step-by-step workflows for API, Web, and Mobile; consolidated Test Case overview and added Execution (Cloud/Local) pages
    • Added comprehensive Assertions docs (Page, Smart, Text, UI), a Web recording guide, and expanded Installation guides for Linux, macOS, and Windows
  • New Features

    • Added Mobile Testing docs and surfaced new assertion types and recording workflows in navigation

@coderabbitai
Copy link

coderabbitai bot commented Feb 4, 2026

📝 Walkthrough

Walkthrough

This PR overhauls documentation: consolidates API/Web/Mobile test-case creation into a unified step-by-step "Adding Test Cases to a Suite" workflow, adds an Assertions doc set and a Web recording guide, creates execution and mobile-testing landing pages with frontmatter, updates installation guides, and modifies navigation in lib/routes-config.ts (adds Mobile Testing and expands Assertions).

Changes

Cohort / File(s) Summary
API/Web/Mobile Test Case Guides
contents/docs/api-testing/create-api-testcase/index.mdx, contents/docs/web-testing/create-web-test/index.mdx, contents/docs/mobile-testing/create-mobile-testcase/index.mdx
Replaced long-form prerequisite-driven guides with a unified, numbered "Adding Test Cases to a Suite" workflow enumerating explicit UI fields and a creation-focused flow.
Test Case & Execution Overviews
contents/docs/test-case/index.mdx, contents/docs/executions/index.mdx, contents/docs/mobile-testing/index.mdx
Condensed test-case landing content to a three-type taxonomy (Web/API/Mobile); added execution overview and mobile-testing landing page linking to related guides.
Assertions Documentation
contents/docs/assertions/index.mdx, contents/docs/assertions/page-assertion/index.mdx, contents/docs/assertions/smart-assertion/index.mdx, contents/docs/assertions/text-assertion/index.mdx, contents/docs/assertions/ui-assertion/index.mdx
Added new Assertions section with pages for Page, Smart, Text, and UI assertions describing types, configuration, and runtime evaluation.
Recording & Web Testing
contents/docs/web-testing/recording/index.mdx
New recording guide covering launch options, recording session behavior, supported actions, assertion tooling during recording, and post-recording step conversion.
Executions Metadata
contents/docs/executions/cloud/index.mdx, contents/docs/executions/local/index.mdx
Added/updated YAML frontmatter (title, description) for execution pages to standardize metadata.
Installation Guides
contents/docs/installation/index.mdx, contents/docs/installation/linux/index.mdx, contents/docs/installation/mac/index.mdx, contents/docs/installation/window/index.mdx
Expanded and restructured OS-specific installation docs with system requirements, download links, step-by-step install instructions, and post-install notes.
Routing Configuration
lib/routes-config.ts
Commented out Quick Tour route; added Mobile Testing route with child Create Mobile test case; expanded Assertions route with Smart/Page/Text/UI items; minor spacing reformat in Integrations entry.
Miscellaneous Docs Additions
contents/docs/assertions/*, contents/docs/executions/*, contents/docs/mobile-testing/*
Multiple new documentation pages and frontmatter additions; primarily content additions and reorganizations.

Sequence Diagram(s)

(omitted — changes are primarily documentation and navigation additions)

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Poem

🐰 Hopping through lines of docs I prance,
Routes and assertions join the dance.
Steps now tidy, guides take flight,
Mobile and web snug in the light.
A rabbit's cheer for docs done right.

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title is vague and generic, using non-descriptive terms that don't convey meaningful information about the substantial changeset. Consider a more specific title that summarizes the main changes, such as 'Restructure API, mobile, and assertion documentation' or 'Reorganize test case and installation guides'.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch test-case-doc

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.

@ayaankhan98
Copy link
Member

/gemini review

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: 9

🤖 Fix all issues with AI agents
In `@contents/docs/api-testing/create-api-testcase/index.mdx`:
- Line 7: Replace the unclear phrase "depends on the suite type API" with a
grammatically correct and clearer wording; locate the sentence containing
"depends on the suite type API" and change it to something like "depends on the
suite's type (for example, API)" or "depends on whether the suite is an API
suite" so the relationship between suite type and test case type is unambiguous.
- Around line 1-3: Add YAML frontmatter to the top of the MDX file containing at
least title and description keys; for example set title: "Creating an API Test
Case" and description: "This guide explains how to create a new API test case
using Robonito." Ensure the frontmatter block (--- delimited) is placed before
the existing content header so metadata is available for navigation and SEO.
- Around line 14-25: Update the incorrect, repeated alt text "Target Suite" for
each image markdown occurrence (e.g., the strings "![Target Suite
](/test-case/target-suite.png)", "![Target Suite
](/test-case/test-case-name.png)", "![Target Suite ](/test-case/api-test.png)",
"![Target Suite ](/test-case/browser.png)", "![Target Suite
](/test-case/url.png)", "![Target Suite ](/test-case/device.png)") so each alt
description accurately reflects the image (e.g., "Target Suite overview", "Test
case name field", "API test type selection", "Browser selection dropdown",
"Target URL field", "Device preset selection") to improve accessibility and
clarity.

In `@contents/docs/executions/cloud/index.mdx`:
- Around line 2-3: The meta description currently references "validating API
responses using assertions" which doesn't match the Cloud execution topic;
update the frontmatter description field (the "description" key alongside
"title") to a Cloud-specific summary—for example: describe deploying/running
executions in the cloud, configuration, and cloud-only considerations—so the
description aligns with the "title: 'Cloud'" page content and search/snippet
text.

In `@contents/docs/executions/index.mdx`:
- Around line 9-11: The link "[Create an API Test Case](./create-api-testcase)"
resolves relative to /executions and will 404; update that link target to the
correct location (either an absolute path like /api-testing/create-api-testcase
or a correct relative path such as ../api-testing/create-api-testcase) so the
"[Create an API Test Case]" link points to the actual guide.

In `@contents/docs/executions/local/index.mdx`:
- Around line 2-3: Update the frontmatter description to match the "Local Guide"
topic rather than assertions: change the description value in the document's
metadata (the description frontmatter key paired with title "Local Guide") to a
short phrase about local execution, e.g., explaining how to run and validate
Robonito locally or how to execute tasks/validate responses in a local
environment so the metadata accurately reflects the page content.

In `@contents/docs/mobile-testing/index.mdx`:
- Around line 12-15: The "Create a Mobile Test Case" link currently uses a
redundant path './mobile-testing/create-mobile-testcase' which resolves to
'/mobile-testing/mobile-testing/create-mobile-testcase'; update the link target
in contents/docs/mobile-testing/index.mdx by replacing
'./mobile-testing/create-mobile-testcase' with the child-relative
'./create-mobile-testcase' (leave the other link
'./configure-mobile-environment' unchanged) so the anchor correctly resolves to
the child page.

In `@contents/docs/test-case/index.mdx`:
- Around line 2-5: Frontmatter `title` ("Introduction to a Test Case") and the
page's first heading ("Test Cases in Robonito") are inconsistent; update one to
match the other so the frontmatter `title` and the top-level heading are
identical—either change the frontmatter `title` to "Test Cases in Robonito" or
change the heading to "Introduction to a Test Case" (ensure you edit the `title`
field in the frontmatter block and the first markdown heading accordingly).
- Around line 13-15: The link label for the mobile entry is inconsistent; change
the link text "[How to create a Mobile test
case](/docs/mobile-testing/create-mobile-testcase)" to match the others by using
"[How to create a mobile test
case](/docs/mobile-testing/create-mobile-testcase)"; locate the Mobile Test
Cases line (the string "Mobile Test Cases:" and the link target
"/docs/mobile-testing/create-mobile-testcase") and update only the visible link
text to use the same capitalization/pattern as the web and API entries.
🧹 Nitpick comments (1)
contents/docs/mobile-testing/create-mobile-testcase/index.mdx (1)

24-25: Use a mobile device preset example here.

Since this is a mobile testing guide, the “Laptop 11” example reads like a web preset and could confuse readers. Consider swapping it for a mobile device example that exists in the UI.

✏️ Example adjustment (replace with an actual preset)
-7. **Select Device** Choose a predefined device preset to define screen resolution and viewport size (for example, Laptop 11 – 1366×768).
+7. **Select Device** Choose a predefined device preset to define screen resolution and viewport size (for example, Pixel 7 – 1080×2400).

Comment on lines +1 to +3
## Creating an API Test Case

# Creating an API Test Case
This guide explains how to create a new API test case using Robonito.
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Missing YAML frontmatter.

This file is missing the YAML frontmatter that other documentation files in this PR have. Adding frontmatter with title and description fields ensures consistent metadata for navigation and SEO.

📝 Suggested fix
+---
+title: 'Creating an API Test Case'
+description: 'Learn how to create an API test case in Robonito.'
+---
+
 ## Creating an API Test Case
📝 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.

Suggested change
## Creating an API Test Case
# Creating an API Test Case
This guide explains how to create a new API test case using Robonito.
---
title: 'Creating an API Test Case'
description: 'Learn how to create an API test case in Robonito.'
---
## Creating an API Test Case
This guide explains how to create a new API test case using Robonito.
🤖 Prompt for AI Agents
In `@contents/docs/api-testing/create-api-testcase/index.mdx` around lines 1 - 3,
Add YAML frontmatter to the top of the MDX file containing at least title and
description keys; for example set title: "Creating an API Test Case" and
description: "This guide explains how to create a new API test case using
Robonito." Ensure the frontmatter block (--- delimited) is placed before the
existing content header so metadata is available for navigation and SEO.

### Adding Test Cases to a Suite

### Prerequisite
Test cases are systematically organized within suites according to functionality or modules. The type of test cases added depends on the suite type API.
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Grammar issue in sentence.

The phrase "depends on the suite type API" is grammatically unclear.

📝 Suggested fix
-Test cases are systematically organized within suites according to functionality or modules. The type of test cases added depends on the suite type API.
+Test cases are systematically organized within suites according to functionality or modules. The type of test cases added depends on the suite type (API).
📝 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.

Suggested change
Test cases are systematically organized within suites according to functionality or modules. The type of test cases added depends on the suite type API.
Test cases are systematically organized within suites according to functionality or modules. The type of test cases added depends on the suite type (API).
🤖 Prompt for AI Agents
In `@contents/docs/api-testing/create-api-testcase/index.mdx` at line 7, Replace
the unclear phrase "depends on the suite type API" with a grammatically correct
and clearer wording; locate the sentence containing "depends on the suite type
API" and change it to something like "depends on the suite's type (for example,
API)" or "depends on whether the suite is an API suite" so the relationship
between suite type and test case type is unambiguous.

Comment on lines +14 to +25
![Target Suite ](/test-case/target-suite.png)
2. **Enter Test Case Name** Provide a clear and descriptive name in the Test case name field to easily identify the test scenario.
![Target Suite ](/test-case/test-case-name.png)
3. **Select Test Type** Choose API as the test case type. This defines the test as an API automation test.
![Target Suite ](/test-case/api-test.png)
4. **Add Description (Optional)** Enter a short description explaining the purpose and scope of the test case.
5. **Select Browser** Choose the browser in which the test will run, such as Google Chrome.
![Target Suite ](/test-case/browser.png)
6. **Enter Target URL** Specify the application URL that will be opened when the test execution starts.
![Target Suite ](/test-case/url.png)
7. **Select Device** Choose a predefined device preset to define screen resolution and viewport size (for example, Laptop 11 – 1366×768).
![Target Suite ](/test-case/device.png)
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Incorrect image alt texts throughout.

All images use "Target Suite" as alt text regardless of what they're depicting. Alt text should accurately describe each image for accessibility.

📝 Suggested fix
 1. **Select Target Suite** Choose an existing test suite from the Target Suite dropdown. You may also type a name to create a new suite where the test case will be added.
 ![Target Suite ](/test-case/target-suite.png)
 2. **Enter Test Case Name** Provide a clear and descriptive name in the Test case name field to easily identify the test scenario.
-![Target Suite ](/test-case/test-case-name.png)
+![Test Case Name](/test-case/test-case-name.png)
 3. **Select Test Type** Choose API as the test case type. This defines the test as an API automation test.
-![Target Suite ](/test-case/api-test.png)
+![API Test Type](/test-case/api-test.png)
 4. **Add Description (Optional)** Enter a short description explaining the purpose and scope of the test case.
 5. **Select Browser** Choose the browser in which the test will run, such as Google Chrome.
-![Target Suite ](/test-case/browser.png)
+![Browser Selection](/test-case/browser.png)
 6. **Enter Target URL** Specify the application URL that will be opened when the test execution starts.
-![Target Suite ](/test-case/url.png)
+![Target URL](/test-case/url.png)
 7. **Select Device** Choose a predefined device preset to define screen resolution and viewport size (for example, Laptop 11 – 1366×768).
-![Target Suite ](/test-case/device.png)
+![Device Selection](/test-case/device.png)
📝 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.

Suggested change
![Target Suite ](/test-case/target-suite.png)
2. **Enter Test Case Name** Provide a clear and descriptive name in the Test case name field to easily identify the test scenario.
![Target Suite ](/test-case/test-case-name.png)
3. **Select Test Type** Choose API as the test case type. This defines the test as an API automation test.
![Target Suite ](/test-case/api-test.png)
4. **Add Description (Optional)** Enter a short description explaining the purpose and scope of the test case.
5. **Select Browser** Choose the browser in which the test will run, such as Google Chrome.
![Target Suite ](/test-case/browser.png)
6. **Enter Target URL** Specify the application URL that will be opened when the test execution starts.
![Target Suite ](/test-case/url.png)
7. **Select Device** Choose a predefined device preset to define screen resolution and viewport size (for example, Laptop 11 – 1366×768).
![Target Suite ](/test-case/device.png)
![Target Suite ](/test-case/target-suite.png)
2. **Enter Test Case Name** Provide a clear and descriptive name in the Test case name field to easily identify the test scenario.
![Test Case Name](/test-case/test-case-name.png)
3. **Select Test Type** Choose API as the test case type. This defines the test as an API automation test.
![API Test Type](/test-case/api-test.png)
4. **Add Description (Optional)** Enter a short description explaining the purpose and scope of the test case.
5. **Select Browser** Choose the browser in which the test will run, such as Google Chrome.
![Browser Selection](/test-case/browser.png)
6. **Enter Target URL** Specify the application URL that will be opened when the test execution starts.
![Target URL](/test-case/url.png)
7. **Select Device** Choose a predefined device preset to define screen resolution and viewport size (for example, Laptop 11 – 1366×768).
![Device Selection](/test-case/device.png)
🧰 Tools
🪛 LanguageTool

[style] ~19-~19: Consider using the synonym “brief” (= concise, using a few words, not lasting long) to strengthen your wording.
Context: ... Add Description (Optional) Enter a short description explaining the purpose and ...

(QUICK_BRIEF)

🤖 Prompt for AI Agents
In `@contents/docs/api-testing/create-api-testcase/index.mdx` around lines 14 -
25, Update the incorrect, repeated alt text "Target Suite" for each image
markdown occurrence (e.g., the strings "![Target Suite
](/test-case/target-suite.png)", "![Target Suite
](/test-case/test-case-name.png)", "![Target Suite ](/test-case/api-test.png)",
"![Target Suite ](/test-case/browser.png)", "![Target Suite
](/test-case/url.png)", "![Target Suite ](/test-case/device.png)") so each alt
description accurately reflects the image (e.g., "Target Suite overview", "Test
case name field", "API test type selection", "Browser selection dropdown",
"Target URL field", "Device preset selection") to improve accessibility and
clarity.

Comment on lines +2 to +3
title: 'Cloud'
description: 'Learn how to validate API responses using assertions in Robonito.'
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Align the meta description with Cloud execution content.

The description mentions validating API responses using assertions, which doesn’t sound Cloud-specific. If this page is about cloud execution, please update the description to match the page topic so search/snippet text isn’t misleading.

✏️ Possible update
-description: 'Learn how to validate API responses using assertions in Robonito.'
+description: 'Learn how to run and monitor tests in the Robonito Cloud.'
🤖 Prompt for AI Agents
In `@contents/docs/executions/cloud/index.mdx` around lines 2 - 3, The meta
description currently references "validating API responses using assertions"
which doesn't match the Cloud execution topic; update the frontmatter
description field (the "description" key alongside "title") to a Cloud-specific
summary—for example: describe deploying/running executions in the cloud,
configuration, and cloud-only considerations—so the description aligns with the
"title: 'Cloud'" page content and search/snippet text.

Comment on lines +9 to +11
Learn how to:

- [Create an API Test Case](./create-api-testcase)
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Fix the API test case link target.

The relative path resolves under /executions. If the guide lives under /api-testing, this link will 404. Consider using an absolute path (or ../api-testing/...) instead.

🔗 Proposed fix
--   [Create an API Test Case](./create-api-testcase)
+-   [Create an API Test Case](/api-testing/create-api-testcase)
📝 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.

Suggested change
Learn how to:
- [Create an API Test Case](./create-api-testcase)
Learn how to:
- [Create an API Test Case](/api-testing/create-api-testcase)
🤖 Prompt for AI Agents
In `@contents/docs/executions/index.mdx` around lines 9 - 11, The link "[Create an
API Test Case](./create-api-testcase)" resolves relative to /executions and will
404; update that link target to the correct location (either an absolute path
like /api-testing/create-api-testcase or a correct relative path such as
../api-testing/create-api-testcase) so the "[Create an API Test Case]" link
points to the actual guide.

Comment on lines +2 to +3
title: 'Local Guide'
description: 'Learn how to validate API responses using assertions in Robonito.'
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Align the meta description with the Local guide topic.

This description reads like the assertions page. If this page is about local execution, update the description to reflect that to avoid confusing metadata.

✏️ Possible update
-description: 'Learn how to validate API responses using assertions in Robonito.'
+description: 'Learn how to run tests locally with Robonito.'
📝 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.

Suggested change
title: 'Local Guide'
description: 'Learn how to validate API responses using assertions in Robonito.'
title: 'Local Guide'
description: 'Learn how to run tests locally with Robonito.'
🤖 Prompt for AI Agents
In `@contents/docs/executions/local/index.mdx` around lines 2 - 3, Update the
frontmatter description to match the "Local Guide" topic rather than assertions:
change the description value in the document's metadata (the description
frontmatter key paired with title "Local Guide") to a short phrase about local
execution, e.g., explaining how to run and validate Robonito locally or how to
execute tasks/validate responses in a local environment so the metadata
accurately reflects the page content.

Comment on lines +12 to +15
Learn how to:

- [Create a Mobile Test Case](./mobile-testing/create-mobile-testcase)
- [Configure Mobile App & Device Settings](./configure-mobile-environment)
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Correct the “Create Mobile Test Case” link path.

./mobile-testing/create-mobile-testcase will resolve to /mobile-testing/mobile-testing/create-mobile-testcase. Use the child path instead.

🔗 Proposed fix
--   [Create a Mobile Test Case](./mobile-testing/create-mobile-testcase)
+-   [Create a Mobile Test Case](./create-mobile-testcase)
📝 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.

Suggested change
Learn how to:
- [Create a Mobile Test Case](./mobile-testing/create-mobile-testcase)
- [Configure Mobile App & Device Settings](./configure-mobile-environment)
Learn how to:
- [Create a Mobile Test Case](./create-mobile-testcase)
- [Configure Mobile App & Device Settings](./configure-mobile-environment)
🤖 Prompt for AI Agents
In `@contents/docs/mobile-testing/index.mdx` around lines 12 - 15, The "Create a
Mobile Test Case" link currently uses a redundant path
'./mobile-testing/create-mobile-testcase' which resolves to
'/mobile-testing/mobile-testing/create-mobile-testcase'; update the link target
in contents/docs/mobile-testing/index.mdx by replacing
'./mobile-testing/create-mobile-testcase' with the child-relative
'./create-mobile-testcase' (leave the other link
'./configure-mobile-environment' unchanged) so the anchor correctly resolves to
the child page.

Comment on lines 2 to +5
title: 'Introduction to a Test Case'
description: 'Learn how to create a test case within a suite in Robonito.'
---
### Introduction to Test Cases in Robonito
### Test Cases in Robonito
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Title mismatch between frontmatter and heading.

The frontmatter title is "Introduction to a Test Case" (line 2), but the first section heading is "Test Cases in Robonito" (line 5). These should be consistent for better navigation and SEO.

📝 Suggested fix

Either update the frontmatter to match:

 ---
-title: 'Introduction to a Test Case'
+title: 'Test Cases in Robonito'
 description: 'Learn how to create a test case within a suite in Robonito.'
 ---

Or update the heading to match the frontmatter:

-### Test Cases in Robonito
+### Introduction to a Test Case
📝 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.

Suggested change
title: 'Introduction to a Test Case'
description: 'Learn how to create a test case within a suite in Robonito.'
---
### Introduction to Test Cases in Robonito
### Test Cases in Robonito
title: 'Test Cases in Robonito'
description: 'Learn how to create a test case within a suite in Robonito.'
---
### Test Cases in Robonito
Suggested change
title: 'Introduction to a Test Case'
description: 'Learn how to create a test case within a suite in Robonito.'
---
### Introduction to Test Cases in Robonito
### Test Cases in Robonito
title: 'Introduction to a Test Case'
description: 'Learn how to create a test case within a suite in Robonito.'
---
### Introduction to a Test Case
🤖 Prompt for AI Agents
In `@contents/docs/test-case/index.mdx` around lines 2 - 5, Frontmatter `title`
("Introduction to a Test Case") and the page's first heading ("Test Cases in
Robonito") are inconsistent; update one to match the other so the frontmatter
`title` and the top-level heading are identical—either change the frontmatter
`title` to "Test Cases in Robonito" or change the heading to "Introduction to a
Test Case" (ensure you edit the `title` field in the frontmatter block and the
first markdown heading accordingly).

Comment on lines +13 to +15
- **Web (UI) Test Cases:** Web test cases automate user interactions with web applications. These tests simulate actions such as clicking elements, filling forms, navigating pages, and validating UI behavior in real browsers. [How to create a web test case](/docs/web-testing/create-web-test).
- **API Test Cases:** API test cases validate backend services by testing API endpoints. They help ensure correct request handling, response validation, performance, and reliability of application APIs. [How to create an API test case](/docs/api-testing/create-api-testcase).
- **Mobile Test Cases:** Mobile test cases are used to automate testing for mobile applications. These tests validate functionality, UI behavior, and workflows on mobile devices. [How to create a Mobile test case](/docs/mobile-testing/create-mobile-testcase).
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Inconsistent capitalization in link text.

The link text for "Mobile test case" uses lowercase "test case" while it should match the consistent pattern of the other entries. Also consider standardizing the phrasing.

📝 Suggested fix
-- **Web (UI) Test Cases:** Web test cases automate user interactions with web applications. These tests simulate actions such as clicking elements, filling forms, navigating pages, and validating UI behavior in real browsers. [How to create a web test case](/docs/web-testing/create-web-test).
-- **API Test Cases:** API test cases validate backend services by testing API endpoints. They help ensure correct request handling, response validation, performance, and reliability of application APIs. [How to create an API test case](/docs/api-testing/create-api-testcase).
-- **Mobile Test Cases:** Mobile test cases are used to automate testing for mobile applications. These tests validate functionality, UI behavior, and workflows on mobile devices. [How to create a Mobile test case](/docs/mobile-testing/create-mobile-testcase).
+- **Web (UI) Test Cases:** Web test cases automate user interactions with web applications. These tests simulate actions such as clicking elements, filling forms, navigating pages, and validating UI behavior in real browsers. [How to create a Web test case](/docs/web-testing/create-web-test).
+- **API Test Cases:** API test cases validate backend services by testing API endpoints. They help ensure correct request handling, response validation, performance, and reliability of application APIs. [How to create an API test case](/docs/api-testing/create-api-testcase).
+- **Mobile Test Cases:** Mobile test cases are used to automate testing for mobile applications. These tests validate functionality, UI behavior, and workflows on mobile devices. [How to create a Mobile test case](/docs/mobile-testing/create-mobile-testcase).
🤖 Prompt for AI Agents
In `@contents/docs/test-case/index.mdx` around lines 13 - 15, The link label for
the mobile entry is inconsistent; change the link text "[How to create a Mobile
test case](/docs/mobile-testing/create-mobile-testcase)" to match the others by
using "[How to create a mobile test
case](/docs/mobile-testing/create-mobile-testcase)"; locate the Mobile Test
Cases line (the string "Mobile Test Cases:" and the link target
"/docs/mobile-testing/create-mobile-testcase") and update only the visible link
text to use the same capitalization/pattern as the web and API entries.

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: 3

🤖 Fix all issues with AI agents
In `@contents/docs/assertions/page-assertion/index.mdx`:
- Around line 21-22: Clarify support status for "Partial Match" in
page-assertion/index.mdx: either remove the ambiguous "(if supported)" qualifier
and list "Partial Match" as supported, or explicitly state it is not yet
implemented and add a short note like "Partial Match — planned/coming soon" (or
similar) so readers know its status; update the list entry that currently reads
"Partial Match (if supported)" accordingly.

In `@contents/docs/web-testing/recording/index.mdx`:
- Around line 97-100: The section heading "Visual Assert" should be renamed to
"UI Assertion" in the file that contains that heading (replace the string
"Visual Assert" with "UI Assertion") so it matches the route label and the
dedicated doc page titled "UI Assertion"; also scan the same document for any
internal links, frontmatter or references that use "Visual Assert" and update
them to "UI Assertion" to keep sidebar navigation and routing consistent.

In `@lib/routes-config.ts`:
- Around line 79-88: The "Assertions" route object inside the ROUTES array has
incorrect 4-space leading indentation; locate the ROUTES declaration and the
object with title "Assertions" and change its leading indentation to match other
top-level entries (2 spaces) so the object keys (title, href, items) align
consistently with the rest of the ROUTES array; ensure there are no other stray
extra spaces in that object so formatting/linting passes.
🧹 Nitpick comments (6)
contents/docs/web-testing/recording/index.mdx (3)

1-5: Missing YAML frontmatter.

Other documentation pages in this PR (e.g., execution docs, mobile-testing docs) include YAML frontmatter with title and description. This file has none, which may affect page title rendering and SEO depending on how the MDX framework resolves metadata.

Consider adding frontmatter:

---
title: Recording a Web Test Case
description: Learn how to record a Web UI test case in Robonito
---

85-96: Add a link for Text Assertion as well.

Smart Assertion (Line 88), Assertions (Line 92), and Page Assertion (Line 96) all include links to their respective doc pages. Text Assertion exists as a doc page and route (/text-assertion) but is not mentioned here at all. If Text Assertion is also available as a recording tool, consider adding a subsection for it alongside the others for completeness.


80-83: Excessive blank lines.

There are three consecutive blank lines here (and similarly around Lines 100–102). Most MDX renderers collapse them, but trimming to a single blank line keeps the source tidy.

contents/docs/assertions/page-assertion/index.mdx (1)

1-1: Flat heading hierarchy — all sections are ### (H3).

Every heading on this page is H3, which produces no visual/structural hierarchy. Since this is a standalone page at its own route (/page-assertion), the top-level heading should be H2 (or H1 depending on how your MDX framework injects titles), and nested sections like "Configuration Options" should be one level deeper than their parent ("Page Title" / "Page URL").

Suggested hierarchy:

Proposed heading structure
-### Page Assertion
+## Page Assertion

-### Page Assertion Types
+## Page Assertion Types

-### Page Title
+### Page Title

-### Configuration Options
+#### Configuration Options

-### Page URL
+### Page URL

-### Configuration Options
+#### Configuration Options

-### Add Page Assertion
+## Add Page Assertion

-### Benefits of Page Assertions
+## Benefits of Page Assertions

Also applies to: 8-8, 13-13, 17-17, 29-29, 33-33, 41-41, 51-51

lib/routes-config.ts (2)

69-69: Duplicate "Assertions" title in navigation.

There are now two entries titled "Assertions" visible in the sidebar:

  1. A child of "API Testing" (Line 69) — resolves to /api-testing/assertions
  2. A top-level route (Line 81) — resolves to /assertions

While the resolved paths are different (thanks to joinPaths), having two items with the same display name in the navigation tree can confuse users. Consider renaming the API Testing child to something more specific like "API Assertions" to disambiguate.

Also applies to: 79-88


112-112: Inconsistent quote style.

This line uses single quotes for the href value while all other entries in the file use double quotes.

Proposed fix
-      { title: "Authenticator Apps", href: '/authenticator-apps' }
+      { title: "Authenticator Apps", href: "/authenticator-apps" },

Note: a trailing comma is also missing here (other entries have trailing commas), which could cause issues if a new item is appended later.

Comment on lines +21 to +22
- Exact Match
- Partial Match (if supported)
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Ambiguous "(if supported)" qualifier.

Documentation should state definitively whether Partial Match is supported. If it is, remove the qualifier. If it isn't yet implemented, either omit it or note it clearly as a planned feature.

🤖 Prompt for AI Agents
In `@contents/docs/assertions/page-assertion/index.mdx` around lines 21 - 22,
Clarify support status for "Partial Match" in page-assertion/index.mdx: either
remove the ambiguous "(if supported)" qualifier and list "Partial Match" as
supported, or explicitly state it is not yet implemented and add a short note
like "Partial Match — planned/coming soon" (or similar) so readers know its
status; update the list entry that currently reads "Partial Match (if
supported)" accordingly.

Comment on lines +97 to +100
### Visual Assert

Validates the visual appearance of UI elements or pages to detect layout or UI changes.

Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Naming mismatch: "Visual Assert" here vs "UI Assertion" in navigation.

This section is titled Visual Assert, but the route config (lib/routes-config.ts, Line 86) and the dedicated doc page use the name UI Assertion. This inconsistency will confuse users trying to find the corresponding documentation from the sidebar.

Align the name with the route/doc page title:

Proposed fix
-### Visual Assert
-
-Validates the visual appearance of UI elements or pages to detect layout or UI changes.
+### UI Assertion
+
+Validates the visual appearance of UI elements or pages to detect layout or UI changes.
+[Learn UI Assertion](/docs/assertions/ui-assertion)
🤖 Prompt for AI Agents
In `@contents/docs/web-testing/recording/index.mdx` around lines 97 - 100, The
section heading "Visual Assert" should be renamed to "UI Assertion" in the file
that contains that heading (replace the string "Visual Assert" with "UI
Assertion") so it matches the route label and the dedicated doc page titled "UI
Assertion"; also scan the same document for any internal links, frontmatter or
references that use "Visual Assert" and update them to "UI Assertion" to keep
sidebar navigation and routing consistent.

Comment on lines +79 to +88
{
title: "Assertions",
href: "/assertions",
items: [
{ title: "Smart Assertion", href: "/smart-assertion" },
{ title: "Page Assertion", href: "/page-assertion" },
{ title: "Text Assertion", href: "/text-assertion" },
{ title: "UI Assertion", href: "/ui-assertion" },
],
},
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Indentation is off — this block has 4-space leading indent instead of 2.

The Assertions route object on Line 79 starts with 4 spaces of indentation, while every other top-level entry in the ROUTES array uses 2 spaces. This is likely a copy-paste artifact.

Proposed fix
-    {
+  {
     title: "Assertions",
     href: "/assertions",
📝 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.

Suggested change
{
title: "Assertions",
href: "/assertions",
items: [
{ title: "Smart Assertion", href: "/smart-assertion" },
{ title: "Page Assertion", href: "/page-assertion" },
{ title: "Text Assertion", href: "/text-assertion" },
{ title: "UI Assertion", href: "/ui-assertion" },
],
},
{
title: "Assertions",
href: "/assertions",
items: [
{ title: "Smart Assertion", href: "/smart-assertion" },
{ title: "Page Assertion", href: "/page-assertion" },
{ title: "Text Assertion", href: "/text-assertion" },
{ title: "UI Assertion", href: "/ui-assertion" },
],
},
🤖 Prompt for AI Agents
In `@lib/routes-config.ts` around lines 79 - 88, The "Assertions" route object
inside the ROUTES array has incorrect 4-space leading indentation; locate the
ROUTES declaration and the object with title "Assertions" and change its leading
indentation to match other top-level entries (2 spaces) so the object keys
(title, href, items) align consistently with the rest of the ROUTES array;
ensure there are no other stray extra spaces in that object so
formatting/linting passes.

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: 7

🤖 Fix all issues with AI agents
In `@contents/docs/installation/index.mdx`:
- Around line 6-14: Update the "System Requirements" section to include the
shared prerequisites (e.g., Google Chrome, stable internet connection, minimum
RAM/disk if applicable) and add clear links to the OS-specific guides by
inserting anchor links to the linux/, mac/, and window/ pages under the OS list;
modify the "System Requirements" heading and list in index.mdx (the "System
Requirements" section) to either consolidate common requirements here and link
to linux/, mac/, window/ for steps, or keep the OS list and append direct links
like "Install on Linux", "Install on macOS", "Install on Windows" that point to
the respective directories.

In `@contents/docs/installation/linux/index.mdx`:
- Line 1: The Linux install doc's top-level heading uses "#" and its sections
use "##", which is inconsistent with macOS/Windows using "###"; update the
headings so the main title line "# Install Robonito on Linux" becomes "###
Install Robonito on Linux" and change any "##" section headings in this file to
"###" to match the other OS guides and keep document hierarchy consistent.
- Around line 31-32: The MDX file ends inside an unclosed fenced code block
starting with the "```bash" that contains "chmod +x Robonito-2.5.0.AppImage";
close that code block, then append the missing Linux steps consistent with
macOS/Windows guides: add a "Run the AppImage" step showing how to execute
"./Robonito-2.5.0.AppImage" in a bash code block, a horizontal rule, and an
"After Installation" section listing post-install checks (e.g., ensure Google
Chrome is installed/up-to-date and that Robonito is ready to record/execute
tests) so the guide is complete and renders correctly.

In `@contents/docs/installation/mac/index.mdx`:
- Line 1: The page title "### Install Robonito on macOS" is using the same
heading level as its subsections, so promote the top-level heading to a single
'#' and change all subsection headings under it to '##' (match the Linux guide
pattern); locate the title string "Install Robonito on macOS" and update it to
use '#' and ensure any existing '###' section headings in this file are demoted
to '##' so the document hierarchy and TOC/screen-reader semantics are correct.
- Around line 10-11: Update the macOS requirements section that currently lists
"Operating System: macOS 11 (Big Sur) or later" and "Architecture: Apple Silicon
(ARM64)" to explicitly state Intel support status: either add a line like "Intel
(x86_64) Macs are not currently supported" if Intel is unsupported, or include
the Intel/x86_64 architecture and the corresponding download link for Intel
builds if they are supported; edit the lines containing "Operating System: macOS
11 (Big Sur) or later" and "Architecture: Apple Silicon (ARM64)" to reflect the
chosen option.

In `@contents/docs/installation/window/index.mdx`:
- Line 30: Replace the vague heading "What to Do" with a descriptive heading
such as "Windows Defender SmartScreen Warning" (or another precise phrase that
matches the section content) so users can quickly scan and understand the topic;
update the heading text in the index.mdx file where the "What to Do" markdown
header appears.
- Line 38: Replace the incorrect alt text "Text Assertions" for the image in the
markdown (the line containing ![Text Assertions](/Windows-Warning.png)) with a
descriptive, accessible alt string such as "Windows Defender SmartScreen
warning" so the image correctly describes the Windows warning prompt; update the
alt text in that markdown image tag to the new descriptive string.
🧹 Nitpick comments (3)
contents/docs/installation/linux/index.mdx (1)

21-21: Hardcoded version 2.5.0 in download URL and bash command.

The version string 2.5.0 is hardcoded in the download link (Line 21) and the chmod command (Line 32). This same issue exists in the macOS (.dmg) and Windows (.exe) guides. Each new release will require updating all three files. Consider centralizing the version (e.g., via an MDX variable or a shared constant) or at minimum noting in a comment that these URLs must be updated per release.

contents/docs/installation/mac/index.mdx (1)

30-37: Permissions section could include the macOS settings path.

Users unfamiliar with macOS security prompts may not know where to grant Accessibility and Screen Recording permissions. A brief pointer to System Settings > Privacy & Security would improve usability.

contents/docs/installation/window/index.mdx (1)

22-46: Duplicated installation steps and confusing flow.

Steps 3–5 under "Installation Steps" (Lines 26–28) are repeated nearly verbatim under "Continue Installation" (Lines 44–46). The current structure is: install steps → SmartScreen warning → repeat install steps, which is disorienting.

Consider restructuring into a single linear flow: download → run installer → handle SmartScreen warning → follow setup wizard → complete.

Proposed restructured flow
 ### Installation Steps

 1. Download the Robonito Windows installer (`.exe`)
 2. Double-click the installer to start the setup
-3. Follow the on-screen instructions in the setup wizard
-4. Choose the installation directory (default is recommended)
-5. Complete the installation process
-
-### What to Do
-
-1. Click **More info**
-2. Click **Run anyway**
-
-This will safely continue the installation.
+3. If Windows Defender SmartScreen appears:
+   - Click **More info**
+   - Click **Run anyway**

 > Robonito is safe to install. This warning does **not** indicate malware—it is a standard Windows security prompt for new applications.
-![Text Assertions](/Windows-Warning.png)
+![Windows Defender SmartScreen warning](/Windows-Warning.png)

-### Continue Installation
-
-After clicking **Run anyway**:
-
-1. Follow the on-screen instructions in the setup wizard
-2. Choose the installation directory (default is recommended)
-3. Complete the installation process
+4. Follow the on-screen instructions in the setup wizard
+5. Choose the installation directory (default is recommended)
+6. Complete the installation process

Comment on lines 6 to 14
### System Requirements

Before installing Robonito, ensure your system meets the following requirements:

### Operating System

- Windows 10 or later
- macOS 11 (Big Sur) or later
- Linux (Ubuntu 20.04+, Debian-based or equivalent)
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

"System Requirements" section is incomplete and missing links to OS-specific guides.

The section header says "System Requirements" but only lists supported operating systems — it omits the common requirements (Google Chrome, internet connection) that every OS-specific page repeats. More importantly, this landing page doesn't link to the individual OS installation guides (linux/, mac/, window/), so users arriving here have no obvious path forward.

Consider either:

  1. Adding direct links to each OS-specific guide under the OS list, or
  2. Consolidating the shared requirements here and linking out for OS-specific steps.
Proposed improvement
 ### System Requirements

 Before installing Robonito, ensure your system meets the following requirements:

-### Operating System
+#### Common Requirements
+
+- **Browser:** Google Chrome (latest version recommended)
+- **Internet Connection:** Required for installation and updates
+
+#### Choose Your Operating System

-- Windows 10 or later  
-- macOS 11 (Big Sur) or later  
-- Linux (Ubuntu 20.04+, Debian-based or equivalent)
+- [Windows 10 or later](./window)
+- [macOS 11 (Big Sur) or later](./mac)
+- [Linux (Ubuntu 20.04+, Debian-based or equivalent)](./linux)
📝 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.

Suggested change
### System Requirements
Before installing Robonito, ensure your system meets the following requirements:
### Operating System
- Windows 10 or later
- macOS 11 (Big Sur) or later
- Linux (Ubuntu 20.04+, Debian-based or equivalent)
### System Requirements
Before installing Robonito, ensure your system meets the following requirements:
#### Common Requirements
- **Browser:** Google Chrome (latest version recommended)
- **Internet Connection:** Required for installation and updates
#### Choose Your Operating System
- [Windows 10 or later](./window)
- [macOS 11 (Big Sur) or later](./mac)
- [Linux (Ubuntu 20.04+, Debian-based or equivalent)](./linux)
🤖 Prompt for AI Agents
In `@contents/docs/installation/index.mdx` around lines 6 - 14, Update the "System
Requirements" section to include the shared prerequisites (e.g., Google Chrome,
stable internet connection, minimum RAM/disk if applicable) and add clear links
to the OS-specific guides by inserting anchor links to the linux/, mac/, and
window/ pages under the OS list; modify the "System Requirements" heading and
list in index.mdx (the "System Requirements" section) to either consolidate
common requirements here and link to linux/, mac/, window/ for steps, or keep
the OS list and append direct links like "Install on Linux", "Install on macOS",
"Install on Windows" that point to the respective directories.

@@ -1,5 +1,32 @@
Robonito is currently compatible with Windows and Mac operating systems. At this time, we are not yet supporting Linux, but we appreciate your interest and feedback.
# Install Robonito on Linux
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Heading levels are inconsistent with the other OS guides.

This file uses # (H1) for the title and ## (H2) for sections, while the macOS and Windows guides both use ### (H3) throughout. This will produce a visually inconsistent navigation and document hierarchy across the installation docs. Align heading levels across all three OS-specific pages.

🤖 Prompt for AI Agents
In `@contents/docs/installation/linux/index.mdx` at line 1, The Linux install
doc's top-level heading uses "#" and its sections use "##", which is
inconsistent with macOS/Windows using "###"; update the headings so the main
title line "# Install Robonito on Linux" becomes "### Install Robonito on Linux"
and change any "##" section headings in this file to "###" to match the other OS
guides and keep document hierarchy consistent.

Comment on lines +31 to +32
```bash
chmod +x Robonito-2.5.0.AppImage
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🔴 Critical

File appears truncated — code block is not closed.

The file ends inside an open fenced code block (```bash) without a closing ```. This will break MDX rendering. Additionally, compared to the macOS and Windows guides, this Linux guide is missing steps after making the file executable (e.g., "Run the AppImage" and an "After Installation" section).

Proposed fix to close the code block and add remaining content
    ```bash
    chmod +x Robonito-2.5.0.AppImage
+   ```
+
+4. Run the AppImage:
+
+   ```bash
+   ./Robonito-2.5.0.AppImage
+   ```
+
+---
+
+## After Installation
+
+- Ensure **Google Chrome** is installed and up to date
+- Robonito is now ready to record and execute tests
🤖 Prompt for AI Agents
In `@contents/docs/installation/linux/index.mdx` around lines 31 - 32, The MDX
file ends inside an unclosed fenced code block starting with the "```bash" that
contains "chmod +x Robonito-2.5.0.AppImage"; close that code block, then append
the missing Linux steps consistent with macOS/Windows guides: add a "Run the
AppImage" step showing how to execute "./Robonito-2.5.0.AppImage" in a bash code
block, a horizontal rule, and an "After Installation" section listing
post-install checks (e.g., ensure Google Chrome is installed/up-to-date and that
Robonito is ready to record/execute tests) so the guide is complete and renders
correctly.

title: Mac Installation
description: Instructions for installing the Robonito Desktop App on Mac.
---
### Install Robonito on macOS
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Page title uses the same heading level (###) as all subsections.

When the title and every section heading are all ###, there's no document hierarchy — the title doesn't stand out and screen readers / TOC generators can't distinguish the page heading from its sections. Use # for the page title and ## for sections (matching a corrected Linux guide), or at minimum promote the title one level above the section headings.

🤖 Prompt for AI Agents
In `@contents/docs/installation/mac/index.mdx` at line 1, The page title "###
Install Robonito on macOS" is using the same heading level as its subsections,
so promote the top-level heading to a single '#' and change all subsection
headings under it to '##' (match the Linux guide pattern); locate the title
string "Install Robonito on macOS" and update it to use '#' and ensure any
existing '###' section headings in this file are demoted to '##' so the document
hierarchy and TOC/screen-reader semantics are correct.

4. Choose the installation directory (default is recommended)
5. Complete the installation process

### What to Do
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Vague section heading "What to Do".

This heading doesn't communicate what the section is about. A clearer heading like "Windows Defender SmartScreen Warning" would help users scanning the page. (This becomes moot if the flow is restructured as suggested above.)

🤖 Prompt for AI Agents
In `@contents/docs/installation/window/index.mdx` at line 30, Replace the vague
heading "What to Do" with a descriptive heading such as "Windows Defender
SmartScreen Warning" (or another precise phrase that matches the section
content) so users can quickly scan and understand the topic; update the heading
text in the index.mdx file where the "What to Do" markdown header appears.

This will safely continue the installation.

> Robonito is safe to install. This warning does **not** indicate malware—it is a standard Windows security prompt for new applications.
![Text Assertions](/Windows-Warning.png)
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Incorrect image alt text — "Text Assertions" should describe the Windows warning.

The alt text Text Assertions is clearly a copy-paste error. This image shows the Windows Defender SmartScreen prompt, so the alt text should reflect that (e.g., Windows Defender SmartScreen warning). Incorrect alt text harms accessibility and is confusing if the image fails to load.

Proposed fix
-![Text Assertions](/Windows-Warning.png)
+![Windows Defender SmartScreen warning](/Windows-Warning.png)
📝 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.

Suggested change
![Text Assertions](/Windows-Warning.png)
![Windows Defender SmartScreen warning](/Windows-Warning.png)
🤖 Prompt for AI Agents
In `@contents/docs/installation/window/index.mdx` at line 38, Replace the
incorrect alt text "Text Assertions" for the image in the markdown (the line
containing ![Text Assertions](/Windows-Warning.png)) with a descriptive,
accessible alt string such as "Windows Defender SmartScreen warning" so the
image correctly describes the Windows warning prompt; update the alt text in
that markdown image tag to the new descriptive string.

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

🤖 Fix all issues with AI agents
In `@contents/docs/installation/index.mdx`:
- Line 13: The macOS download list item in contents/docs/installation/index.mdx
has a leading space before the '-' so it renders as a nested list item; edit the
list block and remove the extra leading space before "- [Download Robonito for
macOS](https://robonito-prod-builds.s3.ap-south-1.amazonaws.com/Robonito-2.5.0-arm64.dmg)"
so it is aligned with the other top-level list entries (ensure the dash begins
at column 1 to restore sibling list item rendering).

In `@contents/docs/installation/mac/index.mdx`:
- Around line 11-16: Update the "### Supported Mac Devices" section to avoid
enumerating chip generations and missing models: replace the explicit per-chip
list lines with a generalized statement such as "Apple Silicon Macs (M1 and
later) — e.g., MacBook Air, MacBook Pro, Mac mini, Mac Studio, iMac, and Mac
Pro" and optionally note that Intel Macs are not supported (or list support
status). Edit the heading "### Supported Mac Devices" and the bullet items shown
in the diff so the content references "Apple Silicon (M1 and later)" and
includes iMac and Mac Pro rather than listing each M# generation.
🧹 Nitpick comments (1)
contents/docs/installation/mac/index.mdx (1)

41-56: Consider mentioning the macOS Gatekeeper warning.

Users downloading a .dmg outside the App Store will likely see a Gatekeeper prompt ("can't be opened because it is from an unidentified developer" or similar). A brief note on how to allow the app (System Settings → Privacy & Security → "Open Anyway") would reduce support friction.

### Operating System

- [Download Robonito for Windows](https://robonito-prod-builds.s3.ap-south-1.amazonaws.com/Robonito-Setup-2.5.0.exe)
- [Download Robonito for macOS](https://robonito-prod-builds.s3.ap-south-1.amazonaws.com/Robonito-2.5.0-arm64.dmg)
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Indentation bug: macOS download link renders as a nested list item.

Line 13 has a leading space before the -, causing Markdown to render it as a sub-item under the Windows link rather than a sibling list item.

Fix
-- [Download Robonito for Windows](https://robonito-prod-builds.s3.ap-south-1.amazonaws.com/Robonito-Setup-2.5.0.exe)
-  [Download Robonito for macOS](https://robonito-prod-builds.s3.ap-south-1.amazonaws.com/Robonito-2.5.0-arm64.dmg)  
+- [Download Robonito for Windows](https://robonito-prod-builds.s3.ap-south-1.amazonaws.com/Robonito-Setup-2.5.0.exe)
+- [Download Robonito for macOS](https://robonito-prod-builds.s3.ap-south-1.amazonaws.com/Robonito-2.5.0-arm64.dmg)
📝 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.

Suggested change
- [Download Robonito for macOS](https://robonito-prod-builds.s3.ap-south-1.amazonaws.com/Robonito-2.5.0-arm64.dmg)
- [Download Robonito for Windows](https://robonito-prod-builds.s3.ap-south-1.amazonaws.com/Robonito-Setup-2.5.0.exe)
- [Download Robonito for macOS](https://robonito-prod-builds.s3.ap-south-1.amazonaws.com/Robonito-2.5.0-arm64.dmg)
🤖 Prompt for AI Agents
In `@contents/docs/installation/index.mdx` at line 13, The macOS download list
item in contents/docs/installation/index.mdx has a leading space before the '-'
so it renders as a nested list item; edit the list block and remove the extra
leading space before "- [Download Robonito for
macOS](https://robonito-prod-builds.s3.ap-south-1.amazonaws.com/Robonito-2.5.0-arm64.dmg)"
so it is aligned with the other top-level list entries (ensure the dash begins
at column 1 to restore sibling list item rendering).

Comment on lines 11 to 16
### Supported Mac Devices

That's it! You're now ready to enjoy using the Robonito Desktop App. If you encounter any issues during installation, feel free to consult the help section on the Robonito website for further assistance.
or join us on [Slack](https://join.slack.com/t/robonito/shared_invite/zt-2vzwc6wol-wJUrgT4aL9~LbhiCYwdczA) No newline at end of file
- MacBook Air (M1, M2, M3)
- MacBook Pro (M1, M2, M3)
- Mac Mini (M1, M2)
- Mac Studio (M1, M2)
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Supported devices list omits M4 chips and several Mac models.

Apple M4 chips shipped in late 2024. Users with M4-based Macs (MacBook Pro M4, Mac mini M4, iMac M4, etc.) may be confused about whether their device is supported. The list also omits iMac and Mac Pro models. Consider generalizing to avoid maintaining a per-generation list:

Suggested simplification
 ### Supported Mac Devices

-- MacBook Air (M1, M2, M3)
-- MacBook Pro (M1, M2, M3)
-- Mac Mini (M1, M2)
-- Mac Studio (M1, M2)
+- Any Mac with Apple Silicon (M1, M2, M3, M4 or later)
📝 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.

Suggested change
### Supported Mac Devices
That's it! You're now ready to enjoy using the Robonito Desktop App. If you encounter any issues during installation, feel free to consult the help section on the Robonito website for further assistance.
or join us on [Slack](https://join.slack.com/t/robonito/shared_invite/zt-2vzwc6wol-wJUrgT4aL9~LbhiCYwdczA)
\ No newline at end of file
- MacBook Air (M1, M2, M3)
- MacBook Pro (M1, M2, M3)
- Mac Mini (M1, M2)
- Mac Studio (M1, M2)
### Supported Mac Devices
- Any Mac with Apple Silicon (M1, M2, M3, M4 or later)
🤖 Prompt for AI Agents
In `@contents/docs/installation/mac/index.mdx` around lines 11 - 16, Update the
"### Supported Mac Devices" section to avoid enumerating chip generations and
missing models: replace the explicit per-chip list lines with a generalized
statement such as "Apple Silicon Macs (M1 and later) — e.g., MacBook Air,
MacBook Pro, Mac mini, Mac Studio, iMac, and Mac Pro" and optionally note that
Intel Macs are not supported (or list support status). Edit the heading "###
Supported Mac Devices" and the bullet items shown in the diff so the content
references "Apple Silicon (M1 and later)" and includes iMac and Mac Pro rather
than listing each M# generation.

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.

2 participants