Added two new FAQs #894
Added two new FAQs #894
Conversation
📝 WalkthroughWalkthroughTwo new FAQ documentation pages were added: one describing how to extract OTPs embedded within HTML tags by capturing with regex and stripping HTML symbols via an addon/NLP step, and another describing how to configure the OracleDB add-on and JDBC connection details. Changes
Sequence Diagram(s)(omitted — changes are documentation-only and do not introduce new multi-component control flow) Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Fix all issues with AI agents
In
@src/pages/docs/FAQs/general/how-do-i-retrieve-the-otp-when-its-embedded-within-html-tags.md:
- Line 23: Replace the singular word "character" with the plural "characters" in
the sentence that currently reads "remove these extra character and extract only
the numeric value" so it correctly reads "...remove these extra characters and
extract only the numeric value"; update the sentence in the same paragraph where
OTP extraction from HTML tags is described.
In
@src/pages/docs/FAQs/general/how-to-configure-the-oracledb-add-on-in-testsigma.md:
- Line 5: There's a typo in the YAML frontmatter key value: update the page_id
value that currently reads "how-to-configure-the-orcacledb-add-on-in-testsigma"
to the correct "how-to-configure-the-oracledb-add-on-in-testsigma" by editing
the page_id entry in the document (look for the page_id symbol in the file).
- Line 48: The JDBC URL template line uses HTML entities "<" and ">"
instead of literal angle brackets, so update the template string (the line
containing
**jdbc:oracle:thin:@//<host>:<port>/<service_name>?user=<username>&password=<password>&internal_logon=<role>**)
to use raw "<" and ">" characters (e.g.,
**jdbc:oracle:thin:@//<host>:<port>/<service_name>?user=<username>&password=<password>&internal_logon=<role>**)
so users can copy the correct JDBC syntax; ensure the Markdown file preserves
the literal angle brackets without unintended HTML escaping.
- Line 62: The JDBC URL example (the string starting with
"jdbc:oracle:thin:@localhost:1521:ORCL") uses &password=<123456789012> with
ambiguous angle brackets; update it to use the same placeholder convention used
elsewhere in this document (e.g., &password=PASSWORD or &password=<PASSWORD> if
angle-bracket placeholders are used throughout) so it's clear the brackets are
not literal, and ensure the placeholder format matches the template syntax
referenced earlier in the file.
🧹 Nitpick comments (1)
src/pages/docs/FAQs/general/how-to-configure-the-oracledb-add-on-in-testsigma.md (1)
18-19: Remove unnecessary markdown separator.Lines 18–19 contain an extra
---separator that creates unnecessary vertical spacing and doesn't add semantic value. Remove it to improve layout.🔧 Proposed fix
--- ---- In Testsigma, the configuration of the Oracle Database add-on requires...
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
src/pages/docs/FAQs/general/how-do-i-retrieve-the-otp-when-its-embedded-within-html-tags.mdsrc/pages/docs/FAQs/general/how-to-configure-the-oracledb-add-on-in-testsigma.md
🧰 Additional context used
🪛 LanguageTool
src/pages/docs/FAQs/general/how-to-configure-the-oracledb-add-on-in-testsigma.md
[grammar] ~24-~24: Ensure spelling is correct
Context: ...ction. --- ## Steps to Install the Addon 1. From the left navigation bar, go to **Ad...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
src/pages/docs/FAQs/general/how-do-i-retrieve-the-otp-when-its-embedded-within-html-tags.md
[grammar] ~23-~23: Ensure spelling is correct
Context: ...s. To use the OTP in test execution, an addon is used to remove these extra character...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~35-~35: Ensure spelling is correct
Context: ...type/). --- ## Steps to Install the Addon 1. From the left navigation bar, go to **Ad...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: CI
🔇 Additional comments (1)
src/pages/docs/FAQs/general/how-do-i-retrieve-the-otp-when-its-embedded-within-html-tags.md (1)
31-31: Verify the external documentation link is current.The prerequisite section links to the MailboxFunctions documentation. Ensure this link is accessible and up-to-date, particularly if the referenced documentation has been moved or reorganized recently.
|
|
||
| --- | ||
|
|
||
| When an OTP is embedded within HTML tags in an email, extracting it using a regex pattern also captures the surrounding HTML symbols. To use the OTP in test execution, an addon is used to remove these extra characters and extract only the numeric value. |
There was a problem hiding this comment.
Fix grammar: use plural "characters".
The sentence uses the singular form "character" but the context requires the plural. Line 23 should read "…remove these extra characters and extract only…"
🔧 Proposed fix
-When an OTP is embedded within HTML tags in an email, extracting it using a regex pattern also captures the surrounding HTML symbols. To use the OTP in test execution, an addon is used to remove these extra character and extract only the numeric value.
+When an OTP is embedded within HTML tags in an email, extracting it using a regex pattern also captures the surrounding HTML symbols. To use the OTP in test execution, an addon is used to remove these extra characters and extract only the numeric value.📝 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.
| When an OTP is embedded within HTML tags in an email, extracting it using a regex pattern also captures the surrounding HTML symbols. To use the OTP in test execution, an addon is used to remove these extra characters and extract only the numeric value. | |
| When an OTP is embedded within HTML tags in an email, extracting it using a regex pattern also captures the surrounding HTML symbols. To use the OTP in test execution, an addon is used to remove these extra characters and extract only the numeric value. |
🧰 Tools
🪛 LanguageTool
[grammar] ~23-~23: Ensure spelling is correct
Context: ...s. To use the OTP in test execution, an addon is used to remove these extra character...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🤖 Prompt for AI Agents
In
@src/pages/docs/FAQs/general/how-do-i-retrieve-the-otp-when-its-embedded-within-html-tags.md
at line 23, Replace the singular word "character" with the plural "characters"
in the sentence that currently reads "remove these extra character and extract
only the numeric value" so it correctly reads "...remove these extra characters
and extract only the numeric value"; update the sentence in the same paragraph
where OTP extraction from HTML tags is described.
src/pages/docs/FAQs/general/how-to-configure-the-oracledb-add-on-in-testsigma.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Fix all issues with AI agents
In
@src/pages/docs/FAQs/general/how-to-configure-the-oracledb-add-on-in-testsigma.md:
- Line 48: The JDBC URL template line still contains HTML-escaped angle
brackets; update the bolded template string that currently reads with entities
(<host> etc.) so it uses literal angle brackets (<host>, <port>,
<service_name>, <username>, <password>, <role>) instead of < and > to
ensure the URL renders and copies correctly in the document (the line shown in
the diff / the bolded jdbc:oracle:thin:@//... template).
- Around line 24-29: The document mixes "Add-on", "Addon", and "Add-ons";
standardize all usages to "Add-on" (singular) and "Add-ons" (plural) throughout
this file: replace occurrences of "Addon" and "Addons" with "Add-on" and
"Add-ons" respectively, and ensure headings and inline mentions (e.g., the
title, the phrase "From the left navigation bar, go to **Addons** and click
**Add-ons**", and the addon name "OracleDB_Queries") follow the hyphenated form
for consistency.
- Line 62: The JDBC URL example currently uses an ambiguous placeholder
&password=<123456789012> which can be mistaken for a literal value; update the
example in the docs (the line containing the JDBC URL example) to use a clear
placeholder consistent with the earlier template on line 48—e.g., replace the
numeric token with a descriptive placeholder like &password=<your_password> (or
use escaped angle brackets <your_password> if needed for Markdown
rendering) so it is unambiguous that this is a placeholder and not an actual
password.
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
src/pages/docs/FAQs/general/how-to-configure-the-oracledb-add-on-in-testsigma.md
🧰 Additional context used
🪛 LanguageTool
src/pages/docs/FAQs/general/how-to-configure-the-oracledb-add-on-in-testsigma.md
[grammar] ~24-~24: Ensure spelling is correct
Context: ...ction. --- ## Steps to Install the Addon 1. From the left navigation bar, go to **Ad...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: CI
🔇 Additional comments (1)
src/pages/docs/FAQs/general/how-to-configure-the-oracledb-add-on-in-testsigma.md (1)
5-5: Good catch on the typo fix.The page_id has been corrected from the previous revision. This ensures consistent URL generation and documentation cross-references.
| ## **Steps to Install the Addon** | ||
|
|
||
| 1. From the left navigation bar, go to **Addons** and click **Add-ons**. | ||
|  | ||
|
|
||
| 2. Under the **New & Updated Addons** section, search for the **OracleDB_Queries** addon and click **Install**. |
There was a problem hiding this comment.
🛠️ Refactor suggestion | 🟠 Major
Standardize terminology: "Add-on" vs "Addon" vs "Add-ons".
The document mixes terminology inconsistently. Line 2 (title) uses "Add-on" (hyphenated), but line 24 uses "Addon" (no hyphen), and line 26 uses both "Addons" and "Add-ons" in the same sentence. Standardize on one form throughout—preferably "Add-on" (hyphenated, singular) and "Add-ons" (hyphenated, plural) to match the title and maintain professional consistency.
♻️ Proposed fix for terminology consistency
-## **Steps to Install the Addon**
+## **Steps to Install the Add-on**
-1. From the left navigation bar, go to **Addons** and click **Add-ons**.
+1. From the left navigation bar, go to **Add-ons** and click **Add-ons**.
-2. Under the **New & Updated Addons** section, search for the **OracleDB_Queries** addon and click **Install**.
+2. Under the **New & Updated Add-ons** section, search for the **OracleDB_Queries** add-on and click **Install**.📝 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.
| ## **Steps to Install the Addon** | |
| 1. From the left navigation bar, go to **Addons** and click **Add-ons**. | |
|  | |
| 2. Under the **New & Updated Addons** section, search for the **OracleDB_Queries** addon and click **Install**. | |
| ## **Steps to Install the Add-on** | |
| 1. From the left navigation bar, go to **Add-ons** and click **Add-ons**. | |
|  | |
| 2. Under the **New & Updated Add-ons** section, search for the **OracleDB_Queries** add-on and click **Install**. |
🧰 Tools
🪛 LanguageTool
[grammar] ~24-~24: Ensure spelling is correct
Context: ...ction. --- ## Steps to Install the Addon 1. From the left navigation bar, go to **Ad...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🤖 Prompt for AI Agents
In
@src/pages/docs/FAQs/general/how-to-configure-the-oracledb-add-on-in-testsigma.md
around lines 24 - 29, The document mixes "Add-on", "Addon", and "Add-ons";
standardize all usages to "Add-on" (singular) and "Add-ons" (plural) throughout
this file: replace occurrences of "Addon" and "Addons" with "Add-on" and
"Add-ons" respectively, and ensure headings and inline mentions (e.g., the
title, the phrase "From the left navigation bar, go to **Addons** and click
**Add-ons**", and the addon name "OracleDB_Queries") follow the hyphenated form
for consistency.
|
|
||
| 3. Click the **DB_Connection_URL** placeholder and use the following syntax to enter the URL: | ||
|
|
||
| **jdbc:oracle:thin:@//<host>:<port>/<service_name>?user=<username>&password=<password>&internal_logon=<role>** |
There was a problem hiding this comment.
HTML entity encoding still present in JDBC URL template.
This issue was flagged in the previous review but remains unresolved. The template uses < and > instead of literal angle brackets, which will render incorrectly when users copy the syntax.
🔧 Proposed fix
- **jdbc:oracle:thin:@//<host>:<port>/<service_name>?user=<username>&password=<password>&internal_logon=<role>**
+ **jdbc:oracle:thin:@//<host>:<port>/<service_name>?user=<username>&password=<password>&internal_logon=<role>**📝 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.
| **jdbc:oracle:thin:@//<host>:<port>/<service_name>?user=<username>&password=<password>&internal_logon=<role>** | |
| **jdbc:oracle:thin:@//<host>:<port>/<service_name>?user=<username>&password=<password>&internal_logon=<role>** |
🤖 Prompt for AI Agents
In
@src/pages/docs/FAQs/general/how-to-configure-the-oracledb-add-on-in-testsigma.md
at line 48, The JDBC URL template line still contains HTML-escaped angle
brackets; update the bolded template string that currently reads with entities
(<host> etc.) so it uses literal angle brackets (<host>, <port>,
<service_name>, <username>, <password>, <role>) instead of < and > to
ensure the URL renders and copies correctly in the document (the line shown in
the diff / the bolded jdbc:oracle:thin:@//... template).
|
|
||
| Example URL using the screenshot details: | ||
|
|
||
| **jdbc:oracle:thin:@localhost:1521:ORCL?user=SYS&password=<123456789012>&internal_logon=SYSDBA** |
There was a problem hiding this comment.
Clarify placeholder notation in example URL.
This issue was flagged in the previous review. The example shows &password=<123456789012> with ambiguous angle brackets. Once the template on line 48 is corrected to use literal angle brackets for placeholders, this example should be updated to clearly distinguish actual values from placeholder notation.
🔧 Proposed fix
- **jdbc:oracle:thin:@localhost:1521:ORCL?user=SYS&password=<123456789012>&internal_logon=SYSDBA**
+ **jdbc:oracle:thin:@localhost:1521:ORCL?user=SYS&password=123456789012&internal_logon=SYSDBA**📝 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.
| **jdbc:oracle:thin:@localhost:1521:ORCL?user=SYS&password=<123456789012>&internal_logon=SYSDBA** | |
| **jdbc:oracle:thin:@localhost:1521:ORCL?user=SYS&password=123456789012&internal_logon=SYSDBA** |
🤖 Prompt for AI Agents
In
@src/pages/docs/FAQs/general/how-to-configure-the-oracledb-add-on-in-testsigma.md
at line 62, The JDBC URL example currently uses an ambiguous placeholder
&password=<123456789012> which can be mistaken for a literal value; update the
example in the docs (the line containing the JDBC URL example) to use a clear
placeholder consistent with the earlier template on line 48—e.g., replace the
numeric token with a descriptive placeholder like &password=<your_password> (or
use escaped angle brackets <your_password> if needed for Markdown
rendering) so it is unambiguous that this is a placeholder and not an actual
password.
Added two new FAQs as per the tickets:
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.