Updated the SEO keywords internal linking in Docs #764
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
WalkthroughStandardizes “Prerequisites” across numerous documentation pages: rephrases concept-oriented lines to documentation-referencing guidance, often converts headers/content into blockquote style, normalizes link casing/text, and adjusts cross-links. Minor editorial tweaks and a few typographical/spacing artifacts were introduced. No functional, code, or API changes. Changes
Sequence Diagram(s)Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
Suggested reviewers
Poem
✨ Finishing Touches🧪 Generate unit tests
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. CodeRabbit Commands (Invoked using PR/Issue comments)Type 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: 26
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (19)
src/pages/docs/test-cases/create-test-steps/actions-and-options-manual/step-options.md (1)
13-14: Fix broken ToC anchor and typo: “Prerequesties” → “Prerequisites.”Current ToC link points to #prerequesties, but the section renders as “Prerequisites” (#prerequisites). This breaks in-page navigation.
- name: "Prerequesties" - url: "#prerequesties" + name: "Prerequisites" + url: "#prerequisites"Also applies to: 51-55
src/pages/docs/test-data/data-generators/friends-function-type.md (1)
22-23: Typo in contextual link name: “Locationsr”.Display name should be “Locations” to match the section.
- name: "Locationsr" + name: "Locations"src/pages/docs/test-plans/run-tests-in-parallel.md (1)
83-91: Invalid HTML in Example block (ul/p nesting and wrong closing tag).
- A ul must contain li children; a p inside ul is invalid.
- Closing tag is but opener is
.
- <ul class="example-list"> - <p>If your subscription allows 1 parallel run and 1 queued run:</p> - <ul> - <li>You can run one test plan in parallel and queue another test plan.</li> - <li>A third test machine will not execute and will be removed from the queue.</li> - <li>Upgrade your subscription for parallel and queued runs to run more tests simultaneously.</li> - </ol> - </ul> + <p>If your subscription allows 1 parallel run and 1 queued run:</p> + <ul class="example-list"> + <li>You can run one test plan in parallel and queue another test plan.</li> + <li>A third test machine will not execute and will be removed from the queue.</li> + <li>Upgrade your subscription for parallel and queued runs to run more tests simultaneously.</li> + </ul>src/pages/docs/integrations/test-management/qtest.md (1)
13-15: Remove duplicate TOC entry for “Trigger qTest Test Plans Using APIs”.- type: link name: "Trigger qTest Test Plans Using APIs" url: "#trigger-qtest-test-plans-using-apis" @@ - - type: link - name: "Trigger qTest Test Plans Using APIs" - url: "#trigger-qtest-test-plans-using-apis"Also applies to: 28-30
src/pages/docs/test-data/data-generators/random-string-function-type.md (3)
3-5: Front matter and description are inconsistent with this page.
- Use page_title (not pagetitle).
- metadesc mentions “Phone Number Function”.
-pagetitle: "Random String: Generate Unique Alphanumeric Usernames" -metadesc: "Phone Number Function generates random cell or phone numbers for testing contact forms, databases, and user profiles in various applications." +page_title: "Random String: Generate Unique Alphanumeric Values" +metadesc: "Generate random alphanumeric strings for identifiers, usernames, passwords, and test data."
25-25: Intro paragraph mentions NameFunctions; make it about Random String.-NameFunctions Function Type in data generators helps you create usernames. It provides unique and random data, offering a wide variety of name-related information for your applications. +The Random String function type generates unique alphanumeric strings for identifiers, usernames, passwords, and other test data needs.
16-17: Replace NameFunctions with RandomStringFunctions in random-string-function-type.md
The TOC entry, descriptive paragraph, section header, and step example currently reference NameFunctions. The correct function type for the Random String generator is RandomStringFunctions. Update as follows:--- src/pages/docs/test-data/data-generators/random-string-function-type.md @@ contextual_links - name: "Selecting Random String as a Function Type for Data Generator" - url: "#selecting-namefunctions-as-a-function-type-for-data-generator" + name: "Selecting RandomStringFunctions as a Function Type for Data Generator" + url: "#selecting-randomstringfunctions-as-a-function-type-for-data-generator" @@ description paragraph -NameFunctions Function Type in data generators helps you create usernames. It provides unique and random data, offering a wide variety of name-related information for your applications. +RandomStringFunctions Function Type in data generators helps you generate random strings. It provides unique and random string data (e.g., alphanumeric identifiers) for your applications. @@ section & step -## **Selecting NameFunctions as a Function Type for Data Generator** +## **Selecting RandomStringFunctions as a Function Type for Data Generator** -4. Select **NameFunctions** from the **Function Type** dropdown list.  +4. Select **RandomStringFunctions** from the **Function Type** dropdown list. src/pages/docs/test-data/data-generators/testdatafromprofile-function-type.md (1)
3-5: Page metadata doesn’t match the topic (mentions EmailFunctions). Fix for SEO.-pagetitle: "Generate and Manage Email Addresses with EmailFunctions" -metadesc: "TestDataFromProfile function type allows you to create various email addresses with ease. Learn to generate usernames, random emails, and domain-specific emails." +pagetitle: "Use TestDataFromProfile to Retrieve Test Data from Profiles" +metadesc: "Learn how to use the TestDataFromProfile function type in Testsigma to fetch data by set name or row number from test data profiles and datasets."src/pages/docs/test-data/data-generators/mailboxaliasfunctions-function-type.md (1)
520-520: Correct typo and bold formatting (“Timeoutv”)User-facing typo; also missing closing bold tag.
- <td><b>Regex</b>: r'https://\w+\.com/\w+'<br><b>Runtime Variable</b>: promotions<br><b>Timeoutv: 30</td> + <td><b>Regex</b>: r'https://\w+\.com/\w+'<br><b>Runtime Variable</b>: promotions<br><b>Timeout</b>: 30</td>src/pages/docs/collaboration/test-cases-review-management.md (1)
3-3: Fix typo in page title“Documentaion” → “Documentation”.
-page_title: "Test Case Review Management | Testsigma Documentaion" +page_title: "Test Case Review Management | Testsigma Documentation"src/pages/docs/FAQs/web-apps/failure-to-link-text-capture.md (2)
71-79: Fix invalid HTML in example list (p inside ul and stray ).This will produce broken markup and can impact styling/SEO.
Apply:
<ul class="example-list"> - <p>If the UI displays <strong>LOGIN</strong> but the HTML shows <strong>login</strong>, the recorder may capture the lowercase version, which could lead to a test case failure.</p> - </ol> + <li>If the UI displays <strong>LOGIN</strong> but the HTML shows <strong>login</strong>, the recorder may capture the lowercase version, which could lead to a test case failure.</li> </ul>
127-135: Fix second example list: same ul/p and stray issue.Apply:
<ul class="example-list"> - <p>If the UI shows <strong>SUBMIT</strong>, but the HTML has it as <strong>submit</strong>, adjust your test case using the visible UI text to account for this difference.</p> - </ol> + <li>If the UI shows <strong>SUBMIT</strong>, but the HTML has it as <strong>submit</strong>, adjust your test case using the visible UI text to account for this difference.</li> </ul>src/pages/docs/test-data/data-generators/random-text-function-type.md (1)
3-5: SEO/title mismatch with page content.Page is “RandomText Function Type,” but pagetitle/metadesc describe phone numbers. This will confuse users and search engines.
Proposed copy:
- pagetitle: “Generate Random Text for Your Applications”
- metadesc: “RandomText generates configurable random strings for testing forms, databases, and user profiles.”
src/pages/docs/test-data/data-generators/emailfunctions-function-type.md (1)
22-26: Correct “Apha Numeric” to “Alphanumeric” and update anchors/TOC.Fix spelling in headings and contextual links to avoid broken anchors.
- name: "Random Apha Numeric Email" - url: "#random-apha-numeric-email" + name: "Random Alphanumeric Email" + url: "#random-alphanumeric-email" - name: "Random Apha Numeric Email with Domain" - url: "#random-apha-numeric-email-with-domain" + name: "Random Alphanumeric Email with Domain" + url: "#random-alphanumeric-email-with-domain" -## **Random Apha Numeric Email** +## **Random Alphanumeric Email** -## **Random Apha Numeric Email with Domain** +## **Random Alphanumeric Email with Domain**Also applies to: 23-23, 25-26, 129-131, 199-201
src/pages/docs/test-cases/step-types/rest-api.md (2)
3-3: Fix typo in pagetitle.Correct “Documentaion” to “Documentation”.
-pagetitle: "Test Step Type: Rest API | Testsigma Documentaion" +pagetitle: "Test Step Type: REST API | Testsigma Documentation"
61-61: Fix “Vaule” typo in example header text.User-facing typo in header name/value pair.
- - **Headers**: Add any necessary headers to the request, such as authentication tokens, content type, or custom headers, *for example, API Key: Accept, Vaule: application/json*. + - **Headers**: Add any necessary headers to the request, such as authentication tokens, content type, or custom headers, *for example, Header: Accept, Value: application/json*.src/pages/docs/test-data/types/overview.md (3)
3-3: Fix SEO-critical typo in page title."Documentaion" → "Documentation".
Apply:
-page_title: "Test Data Types | Testsigma Documentaion" +page_title: "Test Data Types | Testsigma Documentation"
34-35: Broken contextual link: plural/singular mismatch for Data Generator.Contextual link uses "#data-generators" but the H2 is "Data Generator" → "#data-generator". Link will 404.
- name: "Data Generators" - url: "#data-generators" + name: "Data Generator" + url: "#data-generator"Alternatively, rename the H2 to “Data Generators” and keep the plural slug—just ensure both match.
Also applies to: 143-145
40-41: Standardize “Mailbox” spelling and slug.You mix “Mail Box” and “Mailbox”. Use “Mailbox” consistently; update slug accordingly.
- name: "Mail Box" - url: "#mail-box" + name: "Mailbox" + url: "#mailbox" ... - - **Mailbox** + - **Mailbox** ... -## **Mail Box** +## **Mailbox**Also applies to: 76-76, 155-158
Comment on lines
33
to
36
| > ## **Prerequisites** | ||
| > | ||
| > Before you proceed, ensure you understand the concepts of creating a [Test Plan](https://testsigma.com/docs/test-management/test-plans/overview/), [Test Suite](https://testsigma.com/docs/test-management/test-suites/overview/), and [Test Machine](https://testsigma.com/docs/test-management/test-plans/manage-test-machines/). | ||
| > Before you begin, ensure that you have referred to the documentation for [creating a test plan](https://testsigma.com/docs/test-management/test-plans/overview/), [test suite](https://testsigma.com/docs/test-management/test-suites/overview/), and [test machine](https://testsigma.com/docs/test-management/test-plans/manage-test-machines/) in Testsigma. | ||
There was a problem hiding this comment.
🛠️ Refactor suggestion
Prerequisites: move H2 out of blockquote to keep anchor.
- > ## **Prerequisites**
- >
- > Before you begin, ensure that you have referred to the documentation for [creating a test plan](https://testsigma.com/docs/test-management/test-plans/overview/), [test suite](https://testsigma.com/docs/test-management/test-suites/overview/), and [test machine](https://testsigma.com/docs/test-management/test-plans/manage-test-machines/) in Testsigma.
+ ## Prerequisites
+ > Before you begin, ensure that you have referred to the documentation for [creating a test plan](https://testsigma.com/docs/test-management/test-plans/overview/), [test suite](https://testsigma.com/docs/test-management/test-suites/overview/), and [test machine](https://testsigma.com/docs/test-management/test-plans/manage-test-machines/) in Testsigma.📝 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
| > ## **Prerequisites** | |
| > | |
| > Before you proceed, ensure you understand the concepts of creating a [Test Plan](https://testsigma.com/docs/test-management/test-plans/overview/), [Test Suite](https://testsigma.com/docs/test-management/test-suites/overview/), and [Test Machine](https://testsigma.com/docs/test-management/test-plans/manage-test-machines/). | |
| > Before you begin, ensure that you have referred to the documentation for [creating a test plan](https://testsigma.com/docs/test-management/test-plans/overview/), [test suite](https://testsigma.com/docs/test-management/test-suites/overview/), and [test machine](https://testsigma.com/docs/test-management/test-plans/manage-test-machines/) in Testsigma. | |
| ## Prerequisites | |
| > Before you begin, ensure that you have referred to the documentation for [creating a test plan](https://testsigma.com/docs/test-management/test-plans/overview/), [test suite](https://testsigma.com/docs/test-management/test-suites/overview/), and [test machine](https://testsigma.com/docs/test-management/test-plans/manage-test-machines/) in Testsigma. |
🤖 Prompt for AI Agents
In src/pages/docs/accessibility-testing/mobile-accessibility-testing.md around
lines 33 to 36, the "## **Prerequisites**" heading is currently inside a
blockquote which prevents the markdown heading from creating a proper anchor;
remove the leading blockquote marker(s) so the H2 is at top-level (not quoted),
ensure a blank line before and after the heading as needed, and update any
surrounding blockquote content so only the intended paragraph(s) remain quoted.
Comment on lines
37
to
40
| > ## **Prerequisites** | ||
| > | ||
| > Before you begin, enable AI Features from **Settings > Preferences > Generative AI features** and ensure you're familiar with the concepts of [Test Cases](https://testsigma.com/docs/test-cases/manage/add-edit-delete/). | ||
| > Before you begin, enable AI Features from **Settings > Preferences > Generative AI features** and have referred to the documentation on [creating a test cases](https://testsigma.com/docs/test-cases/manage/add-edit-delete/). | ||
There was a problem hiding this comment.
Grammar and UI label consistency in prerequisites.
Fix “creating a test cases” and align the feature label (“Generative AI features”) consistently in the sentence.
Apply this diff:
-> Before you begin, enable AI Features from **Settings > Preferences > Generative AI features** and have referred to the documentation on [creating a test cases](https://testsigma.com/docs/test-cases/manage/add-edit-delete/).
+> Before you begin, enable **Generative AI features** in **Settings > Preferences**, and review the documentation on [creating test cases](https://testsigma.com/docs/test-cases/manage/add-edit-delete/).📝 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
| > ## **Prerequisites** | |
| > | |
| > Before you begin, enable AI Features from **Settings > Preferences > Generative AI features** and ensure you're familiar with the concepts of [Test Cases](https://testsigma.com/docs/test-cases/manage/add-edit-delete/). | |
| > Before you begin, enable AI Features from **Settings > Preferences > Generative AI features** and have referred to the documentation on [creating a test cases](https://testsigma.com/docs/test-cases/manage/add-edit-delete/). | |
| > ## **Prerequisites** | |
| > | |
| > Before you begin, enable **Generative AI features** in **Settings > Preferences**, and review the documentation on [creating test cases](https://testsigma.com/docs/test-cases/manage/add-edit-delete/). |
🤖 Prompt for AI Agents
In src/pages/docs/atto/generative-ai/copilot/web-recorder.md around lines 37 to
40, the prerequisite sentence has a grammar error ("creating a test cases") and
an inconsistent UI label ("Generative AI features"); change the link text to
"creating test cases" and update the UI path to consistently use the correct
capitalization "Settings > Preferences > Generative AI Features" so the sentence
reads cleanly and matches the product UI.
Comment on lines
+85
to
86
| 4. You can **Save Filters** to quickly access and manage test cases associated with a particular functionality or scenario, such as those related to login. For more information on how to save test case filter, refer to the documentation on [save test case filter](https://testsigma.com/docs/test-cases/manage/list-actions/#save-test-case-filter). | ||
|
|
There was a problem hiding this comment.
Grammar: add article and title-case link text.
-4. You can **Save Filters** to quickly access and manage test cases associated with a particular functionality or scenario, such as those related to login. For more information on how to save test case filter, refer to the documentation on [save test case filter](https://testsigma.com/docs/test-cases/manage/list-actions/#save-test-case-filter).
+4. You can **Save Filters** to quickly access and manage test cases associated with a particular functionality or scenario, such as those related to login. For more information on how to save a test case filter, refer to the documentation on [Save Test Case Filter](https://testsigma.com/docs/test-cases/manage/list-actions/#save-test-case-filter).📝 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
| 4. You can **Save Filters** to quickly access and manage test cases associated with a particular functionality or scenario, such as those related to login. For more information on how to save test case filter, refer to the documentation on [save test case filter](https://testsigma.com/docs/test-cases/manage/list-actions/#save-test-case-filter). | |
| 4. You can **Save Filters** to quickly access and manage test cases associated with a particular functionality or scenario, such as those related to login. For more information on how to save a test case filter, refer to the documentation on [Save Test Case Filter](https://testsigma.com/docs/test-cases/manage/list-actions/#save-test-case-filter). |
🧰 Tools
🪛 LanguageTool
[grammar] ~85-~85: There might be a mistake here.
Context: ...o login. For more information on how to save test case filter, refer to the document...
(QB_NEW_EN)
🤖 Prompt for AI Agents
In src/pages/docs/best-practices/best-practices.md around lines 85-86, the
sentence should add the definite article and use title-case for the link text;
update the sentence to include "the" before the documentation reference and
change the linked text to "Save Test Case Filter" (title-case) so it reads
something like: "...refer to the documentation on the Save Test Case Filter."
Ensure the link target remains the same.
Comment on lines
+117
to
119
| 2. You should map appropriate context details when you create elements inside **iFrames** or **Shadow DOM** contexts. Mapping context details will ensure you correctly identify and interact with elements within specific contexts. For more information refer to Shadow DOM Element. For more information on how to create a shadow DOM element, refer to the documentation on [create a shadow DOM element](https://testsigma.com/docs/elements/web-apps/shadow-dom/#create-element-for-shadow-dom). | ||
| 3. You can easily access elements by saving filters and creating views based on screen names. They can check for the presence of elements in Testsigma's repository before recreating them. Element management is facilitated by adding filters. For more information on how to save element filters, refer to the documentation on[save element filters](https://testsigma.com/docs/elements/overview/#save-element-filter). | ||
|
|
There was a problem hiding this comment.
Tighten Shadow DOM sentence and fix missing space before link.
-2. You should map appropriate context details when you create elements inside **iFrames** or **Shadow DOM** contexts. Mapping context details will ensure you correctly identify and interact with elements within specific contexts. For more information refer to Shadow DOM Element. For more information on how to create a shadow DOM element, refer to the documentation on[create a shadow DOM element](https://testsigma.com/docs/elements/web-apps/shadow-dom/#create-element-for-shadow-dom).
+2. Map the appropriate context when you create elements inside **iFrames** or **Shadow DOM**. This ensures you correctly identify and interact with elements. For more details, see the Shadow DOM article and the documentation on [creating a Shadow DOM element](https://testsigma.com/docs/elements/web-apps/shadow-dom/#create-element-for-shadow-dom).
-3. You can easily access elements by saving filters and creating views based on screen names. They can check for the presence of elements in Testsigma's repository before recreating them. Element management is facilitated by adding filters. For more information on how to save element filters, refer to the documentation on[save element filters](https://testsigma.com/docs/elements/overview/#save-element-filter).
+3. You can access elements by saving filters and creating views based on screen names. Check for the presence of elements in the repository before recreating them. For more information on saving element filters, refer to the documentation on [Save Element Filters](https://testsigma.com/docs/elements/overview/#save-element-filter).📝 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
| 2. You should map appropriate context details when you create elements inside **iFrames** or **Shadow DOM** contexts. Mapping context details will ensure you correctly identify and interact with elements within specific contexts. For more information refer to Shadow DOM Element. For more information on how to create a shadow DOM element, refer to the documentation on [create a shadow DOM element](https://testsigma.com/docs/elements/web-apps/shadow-dom/#create-element-for-shadow-dom). | |
| 3. You can easily access elements by saving filters and creating views based on screen names. They can check for the presence of elements in Testsigma's repository before recreating them. Element management is facilitated by adding filters. For more information on how to save element filters, refer to the documentation on[save element filters](https://testsigma.com/docs/elements/overview/#save-element-filter). | |
| 2. Map the appropriate context when you create elements inside **iFrames** or **Shadow DOM**. This ensures you correctly identify and interact with elements. For more details, see the Shadow DOM article and the documentation on [creating a Shadow DOM element](https://testsigma.com/docs/elements/web-apps/shadow-dom/#create-element-for-shadow-dom). | |
| 3. You can access elements by saving filters and creating views based on screen names. Check for the presence of elements in the repository before recreating them. For more information on saving element filters, refer to the documentation on [Save Element Filters](https://testsigma.com/docs/elements/overview/#save-element-filter). |
🤖 Prompt for AI Agents
In src/pages/docs/best-practices/best-practices.md around lines 117 to 119,
tighten and clarify the Shadow DOM sentence and add the missing space before the
save-filters link: rephrase the Shadow DOM guidance into a single concise
sentence (e.g., "When creating elements inside iFrames or Shadow DOM, map the
appropriate context details so you can correctly identify and interact with
those elements; see create a shadow DOM element.") and ensure there is a space
between "documentation on" and the [save element filters] link so the link
renders correctly.
Comment on lines
+130
to
+131
| |**Runtime**|The values are the same throughout a sequential test run; other tests can update them. For more information on runtime varibale, refer to the documentation on [runtime variable](https://testsigma.com/docs/test-data/types/runtime/).|<li>During test execution, store session-specific data or dynamic values.</li><li>Create test steps using the data type <strong>$ divText</strong>.</li><li>Example: //button[text()=’$\|divText\|’] </li>| | ||
| |**Test Data Profile**|<li>You can link specific test cases. You can update the values in test data profiles from other test cases.</li><li>To create a Test Data Profile, navigate to **Test Data** > **Test Data Profile** > **Create**. For more information on test data profile, refer to the documentation on [test data profile](https://testsigma.com/docs/test-data/create-data-profiles/)</li>|<li>Use data-driven testing and maintain test data sets.</li><li>Create test steps using the data type **@ username**.</li><li>Example: //button[text()=’@\|username\|’]</li>| |
There was a problem hiding this comment.
Fix “varibale” typo and clarify description.
-|**Runtime**|The values are the same throughout a sequential test run; other tests can update them. For more information on runtime varibale, refer to the documentation on [runtime variable](https://testsigma.com/docs/test-data/types/runtime/).|<li>During test execution, store session-specific data or dynamic values.</li><li>Create test steps using the data type <strong>$ divText</strong>.</li><li>Example: //button[text()=’$\|divText\|’] </li>|
+|**Runtime**|Values persist through a sequential test run and can be updated by other tests. For more information on runtime variables, refer to the documentation on [Runtime Variable](https://testsigma.com/docs/test-data/types/runtime/).|<li>During test execution, store session-specific or dynamic values.</li><li>Create test steps using the data type <strong>$ divText</strong>.</li><li>Example: //button[text()=’$\|divText\|’]</li>|📝 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
| |**Runtime**|The values are the same throughout a sequential test run; other tests can update them. For more information on runtime varibale, refer to the documentation on [runtime variable](https://testsigma.com/docs/test-data/types/runtime/).|<li>During test execution, store session-specific data or dynamic values.</li><li>Create test steps using the data type <strong>$ divText</strong>.</li><li>Example: //button[text()=’$\|divText\|’] </li>| | |
| |**Test Data Profile**|<li>You can link specific test cases. You can update the values in test data profiles from other test cases.</li><li>To create a Test Data Profile, navigate to **Test Data** > **Test Data Profile** > **Create**. For more information on test data profile, refer to the documentation on [test data profile](https://testsigma.com/docs/test-data/create-data-profiles/)</li>|<li>Use data-driven testing and maintain test data sets.</li><li>Create test steps using the data type **@ username**.</li><li>Example: //button[text()=’@\|username\|’]</li>| | |
| |**Runtime**|Values persist through a sequential test run and can be updated by other tests. For more information on runtime variables, refer to the documentation on [Runtime Variable](https://testsigma.com/docs/test-data/types/runtime/).|<li>During test execution, store session-specific or dynamic values.</li><li>Create test steps using the data type <strong>$ divText</strong>.</li><li>Example: //button[text()=’$\|divText\|’]</li>| |
🧰 Tools
🪛 LanguageTool
[grammar] ~130-~130: Ensure spelling is correct
Context: ...e them. For more information on runtime varibale, refer to the documentation on [runtime...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~130-~130: There might be a mistake here.
Context: ...: //button[text()=’$|divText|’] | |Test Data Profile|
(QB_NEW_EN)
🤖 Prompt for AI Agents
In src/pages/docs/best-practices/best-practices.md around lines 130 to 131, fix
the typo "varibale" to "variable" and rewrite the runtime description for
clarity: change "The values are the same throughout a sequential test run; other
tests can update them. For more information on runtime varibale, refer to the
documentation on [runtime variable](...)" to a clearer sentence such as "Values
persist for the duration of a sequential test run but can be updated by other
tests; for more information on runtime variables, see the documentation on
[runtime variables](...)." Ensure the link text matches "runtime variables" and
preserve existing link URL.
| ## **Random** | ||
|
|
||
| Random Test Data Type generates random data such as numbers, email addresses, and passwords to add variety to your tests and create diverse test scenarios with unpredictable data. You can use the format **~ Random** and replace **~ Random** with an integer value from 1 to 256 to generate random values for Test Case execution. During Test Case Execution, you can specify the length of the alphanumeric character you want to receive by providing an integer value. Refer to the [Random Test Data](https://testsigma.com/docs/test-data/types/random/) for more information.  | ||
| Random Test Data Type generates random data such as numbers, email addresses, and passwords to add variety to your tests and create diverse test scenarios with unpredictable data. You can use the format **~ Random** and replace **~ Random** with an integer value from 1 to 256 to generate random values for Test Case execution. During Test Case Execution, you can specify the length of the alphanumeric character you want to receive by providing an integer value. For more information on Random, refer to the documentation on [random testdata](https://testsigma.com/docs/test-data/types/random/).  |
There was a problem hiding this comment.
Correct Random syntax and clarify usage.
Current text mentions “~ Random” but examples use “~|N|”.
-Random Test Data Type generates random data such as numbers, email addresses, and passwords to add variety to your tests and create diverse test scenarios with unpredictable data. You can use the format **~ Random** and replace **~ Random** with an integer value from 1 to 256 to generate random values for Test Case execution. During Test Case Execution, you can specify the length of the alphanumeric character you want to receive by providing an integer value. For more information on Random, refer to the documentation on [random testdata](https://testsigma.com/docs/test-data/types/random/). 
+Random Test Data generates random values (numbers, emails, passwords). Use the **~|N|** format to generate an alphanumeric string of length N (1–256) during execution. For more details, see [random test data](https://testsigma.com/docs/test-data/types/random/).
+
+ Also applies to: 138-139
🤖 Prompt for AI Agents
In src/pages/docs/test-data/types/overview.md around line 136 (and also update
lines 138-139), the text incorrectly references the Random syntax as “~ Random”
while examples use “~|N|”; update the wording to use the correct syntax "~|N|"
everywhere, clarify that N is an integer from 1 to 256 specifying the desired
length of the generated alphanumeric string (or number as applicable), adjust
the sentence to state you should replace "~|N|" with the integer to control
length during Test Case execution, and make the same correction in the related
example lines 138-139 so the examples match the explanation and link remains
unchanged.
Comment on lines
35
to
+37
| > ## **Prerequisites** | ||
| > | ||
| > Before you proceed, ensure you understand the concepts of creating a [Test Plan](https://testsigma.com/docs/test-management/test-plans/overview/), [Test Suite](https://testsigma.com/docs/test-management/test-suites/overview/), and [Test Machine](https://testsigma.com/docs/test-management/test-plans/manage-test-machines/). | ||
| > Before you begin, ensure that you have referred to the documentation for [creating test plan](https://testsigma.com/docs/test-management/test-plans/overview/), [test suite](https://testsigma.com/docs/test-management/test-suites/overview/), and [test machine](https://testsigma.com/docs/test-management/test-plans/manage-test-machines/). |
There was a problem hiding this comment.
Correct article usage and remove double spaces (user-facing grammar).
“creating test plan” → “creating a test plan”; remove extra spaces after commas.
-> Before you begin, ensure that you have referred to the documentation for [creating test plan](https://testsigma.com/docs/test-management/test-plans/overview/), [test suite](https://testsigma.com/docs/test-management/test-suites/overview/), and [test machine](https://testsigma.com/docs/test-management/test-plans/manage-test-machines/).
+> Before you begin, ensure that you have referred to the documentation for [creating a test plan](https://testsigma.com/docs/test-management/test-plans/overview/), [test suite](https://testsigma.com/docs/test-management/test-suites/overview/), and [test machine](https://testsigma.com/docs/test-management/test-plans/manage-test-machines/).📝 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
| > ## **Prerequisites** | |
| > | |
| > Before you proceed, ensure you understand the concepts of creating a [Test Plan](https://testsigma.com/docs/test-management/test-plans/overview/), [Test Suite](https://testsigma.com/docs/test-management/test-suites/overview/), and [Test Machine](https://testsigma.com/docs/test-management/test-plans/manage-test-machines/). | |
| > Before you begin, ensure that you have referred to the documentation for [creating test plan](https://testsigma.com/docs/test-management/test-plans/overview/), [test suite](https://testsigma.com/docs/test-management/test-suites/overview/), and [test machine](https://testsigma.com/docs/test-management/test-plans/manage-test-machines/). | |
| > ## **Prerequisites** | |
| > | |
| > Before you begin, ensure that you have referred to the documentation for [creating a test plan](https://testsigma.com/docs/test-management/test-plans/overview/), [test suite](https://testsigma.com/docs/test-management/test-suites/overview/), and [test machine](https://testsigma.com/docs/test-management/test-plans/manage-test-machines/). |
🧰 Tools
🪛 LanguageTool
[grammar] ~37-~37: There might be a mistake here.
Context: ...have referred to the documentation for [creating test plan](https://testsigma.com/docs/t...
(QB_NEW_EN)
🤖 Prompt for AI Agents
In src/pages/docs/test-plans/distributed-testing.md around lines 35 to 37, the
user-facing text in the prerequisites section uses incorrect article phrasing
and contains double spaces after commas; change the link text "creating test
plan" to "creating a test plan" and remove the extra spaces after commas so the
sentence reads with proper spacing and grammar while keeping the existing link
targets unchanged.
| > ## **Prerequisites** | ||
| > | ||
| > Before you proceed, ensure you understand the concepts of creating a [Test Suite](https://testsigma.com/docs/test-management/test-suites/overview/) and [Test Plan](https://testsigma.com/docs/test-management/test-plans/overview/). | ||
| > Before you begin, ensure that you have referred to the documentation for [creating test suite](https://testsigma.com/docs/test-management/test-suites/overview/) and a [test plan](https://testsigma.com/docs/test-management/test-plans/overview/). |
There was a problem hiding this comment.
Grammar: add missing article and improve parallelism.
“creating test suite and a test plan” → “creating a test suite and a test plan”.
-> Before you begin, ensure that you have referred to the documentation for [creating test suite](https://testsigma.com/docs/test-management/test-suites/overview/) and a [test plan](https://testsigma.com/docs/test-management/test-plans/overview/).
+> Before you begin, ensure that you have referred to the documentation for [creating a test suite](https://testsigma.com/docs/test-management/test-suites/overview/) and [creating a test plan](https://testsigma.com/docs/test-management/test-plans/overview/).📝 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
| > Before you begin, ensure that you have referred to the documentation for [creating test suite](https://testsigma.com/docs/test-management/test-suites/overview/) and a [test plan](https://testsigma.com/docs/test-management/test-plans/overview/). | |
| > Before you begin, ensure that you have referred to the documentation for [creating a test suite](https://testsigma.com/docs/test-management/test-suites/overview/) and [creating a test plan](https://testsigma.com/docs/test-management/test-plans/overview/). |
🧰 Tools
🪛 LanguageTool
[grammar] ~35-~35: There might be a mistake here.
Context: ...have referred to the documentation for [creating test suite](https://testsigma.com/docs/...
(QB_NEW_EN)
🤖 Prompt for AI Agents
In src/pages/docs/test-plans/manage-test-machines.md around line 35, the phrase
"creating test suite and a test plan" is missing an article and needs parallel
structure; change it to "creating a test suite and a test plan" so both nouns
have the correct article and parallel form, and update the linked text
accordingly.
Comment on lines
35
to
+37
| > ## **Prerequisites** | ||
| > | ||
| > Before you schedule a test plan in Testsigma, you must understand the concepts of creating the [Test Plan](https://testsigma.com/docs/test-management/test-plans/overview/). | ||
| > Before you begin, ensure that you have referred to the documentation for [creating test plan](https://testsigma.com/docs/test-management/test-plans/overview/) before scheduling a test plan in Testsigma. |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Verify anchor generation for “Prerequisites” inside a blockquote.
“Prerequisites” is now an H2 inside a blockquote. Some generators won’t emit an ID for blockquoted headings, which can break the contextual_links “#prerequisites” anchor.
🏁 Script executed:
#!/bin/bash
# List docs whose contextual_links reference "#prerequisites" but use a blockquoted heading instead of a bare H2.
rg -nP '^contextual_links:(?s).*?#prerequisites' -C0 src/pages/docs | awk -F: '{print $1}' | sort -u | while read -r f; do
echo "File: $f"
# Expect at least one bare H2 "## Prerequisites" line; flag if only blockquoted form is present.
if rg -q '^##\s+\*?\*?Prerequisites' "$f"; then
echo " OK: bare H2 present"
elif rg -q '^>\s*##\s+\*?\*?Prerequisites' "$f"; then
echo " WARN: only blockquoted H2 found (anchor may not be generated)."
else
echo " ERROR: no H2 'Prerequisites' found."
fi
doneLength of output: 114
🏁 Script executed:
#!/bin/bash
file="src/pages/docs/test-plans/schedule-plans.md"
echo "=== Contextual_links block ==="
sed -n '/^contextual_links:/,/^$/p' "$file" || echo "No contextual_links section"
echo
echo "=== Occurrences of '#prerequisites' ==="
grep -n "#prerequisites" "$file" || echo "None found"
echo
echo "=== All headings containing 'Prerequisites' ==="
grep -n "##.*Prerequisites" "$file" || echo "None found"
echo
echo "=== Blockquoted H2 'Prerequisites' ==="
grep -n "^>.*##.*Prerequisites" "$file" || echo "None found"Length of output: 1284
Move the “## Prerequisites” heading out of the blockquote
The only “## Prerequisites” heading (line 35 in src/pages/docs/test-plans/schedule-plans.md) is inside a blockquote, which may prevent a #prerequisites anchor from being generated—breaks the contextual_links reference. Extract it as a top-level H2 so the link resolves.
🧰 Tools
🪛 LanguageTool
[grammar] ~37-~37: There might be a mistake here.
Context: ...have referred to the documentation for [creating test plan](https://testsigma.com/docs/t...
(QB_NEW_EN)
🤖 Prompt for AI Agents
In src/pages/docs/test-plans/schedule-plans.md around lines 35 to 37, the "##
Prerequisites" H2 is currently inside a blockquote which prevents generation of
the #prerequisites anchor; move the "## Prerequisites" heading out of the
blockquote so it is a top-level H2 (remove the leading blockquote marker for
that line and adjust surrounding blockquote content if needed) ensuring the
anchor and contextual_links resolve correctly.
| ### **Prerequisites** | ||
|
|
||
| Before uploading the Android and iOS applications, you must understand specific concepts, such as creating [Projects](https://testsigma.com/docs/projects/overview/) and [Test Cases](https://testsigma.com/docs/test-cases/manage/add-edit-delete/) and uploading the **Android** app as a **.apk** file and the **iOS** app as a **.ipa** file for testing. | ||
| Before uploading the Android and iOS applications, ensure that you have referred to the documentation for [projects](https://testsigma.com/docs/projects/overview/) and [test cases](https://testsigma.com/docs/test-cases/manage/add-edit-delete/) and uploading the **Android** app as a **.apk** file and the **iOS** app as a **.ipa** file for testing. |
There was a problem hiding this comment.
Improve grammar and parallel structure in prerequisites.
Reads awkwardly (“and uploading…”). Also use “an .apk/.ipa”.
Apply this diff:
-Before uploading the Android and iOS applications, ensure that you have referred to the documentation for [projects](https://testsigma.com/docs/projects/overview/) and [test cases](https://testsigma.com/docs/test-cases/manage/add-edit-delete/) and uploading the **Android** app as a **.apk** file and the **iOS** app as a **.ipa** file for testing.
+Before uploading Android and iOS applications, review the documentation for [projects](https://testsigma.com/docs/projects/overview/) and [test cases](https://testsigma.com/docs/test-cases/manage/add-edit-delete/), and ensure you upload the **Android** app as an **.apk** file and the **iOS** app as an **.ipa** file for testing.📝 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
| Before uploading the Android and iOS applications, ensure that you have referred to the documentation for [projects](https://testsigma.com/docs/projects/overview/) and [test cases](https://testsigma.com/docs/test-cases/manage/add-edit-delete/) and uploading the **Android** app as a **.apk** file and the **iOS** app as a **.ipa** file for testing. | |
| Before uploading Android and iOS applications, review the documentation for [projects](https://testsigma.com/docs/projects/overview/) and [test cases](https://testsigma.com/docs/test-cases/manage/add-edit-delete/), and ensure you upload the **Android** app as an **.apk** file and the **iOS** app as an **.ipa** file for testing. |
🤖 Prompt for AI Agents
In src/pages/docs/uploads/upload-apps.md around line 32, the prerequisite
sentence is awkward and lacks parallel structure; replace it with a single clear
sentence that references the projects and test cases docs and uses correct
articles: instruct the writer to say they should refer to the projects and test
cases documentation and then upload the Android app as an .apk file and the iOS
app as an .ipa file (use "an .apk" and "an .ipa").
bharathk08
approved these changes
Sep 3, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updated the SEO keywords internal linking in Docs as per the ticket: https://testsigma.atlassian.net/browse/DOC-349
Summary by CodeRabbit