Skip to content

Conversation

@Nandhini4501
Copy link
Contributor

@Nandhini4501 Nandhini4501 commented Jan 7, 2026

Added two new FAQs as per the tickets:

https://testsigma.atlassian.net/browse/DOC-487
https://testsigma.atlassian.net/browse/DOC-497

Screenshot 2026-01-07 at 2 28 29 PM Screenshot 2026-01-07 at 2 28 47 PM

Summary by CodeRabbit

Release Notes

  • Documentation
    • Added comprehensive guide for extracting OTPs embedded within HTML tags using the addon, with step-by-step instructions and examples.
    • Added comprehensive guide for configuring the OracleDB Add-on in Testsigma, including installation and database connection setup procedures.

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

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 7, 2026

📝 Walkthrough

Walkthrough

Two new FAQ documentation pages are added to the Testsigma docs. One explains how to retrieve OTPs embedded within HTML tags using addons and NLP actions; the other provides a configuration guide for the OracleDB Add-on including JDBC URL setup and query examples.

Changes

Cohort / File(s) Summary
FAQ Documentation - OTP Extraction
src/pages/docs/FAQs/general/how-do-i-retrieve-the-otp-when-its-embedded-within-html-tags.md
New FAQ page with YAML front-matter and structured guide for extracting OTPs from HTML-embedded content using addon installation and NLP actions with pattern matching and data generators. Includes prerequisites, step-by-step instructions, and visual references.
FAQ Documentation - OracleDB Configuration
src/pages/docs/FAQs/general/how-to-configure-the-oracledb-add-on-in-testsigma.md
New FAQ page documenting OracleDB Add-on setup with YAML front-matter. Covers addon installation, database connection configuration, JDBC URL construction, example SQL queries, and row count specifications with illustrative images.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

  • PR #824: Adds complementary FAQ documentation about extracting OTPs from authenticator apps and TOTP secrets, closely related to OTP handling workflows in Testsigma.

Suggested reviewers

  • bharathk08

Poem

🐰 Two new docs hop into place,
OTP tricks and database grace,
With HTML tags no match for our minds,
And Oracle configs perfectly designed! 🎯

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Added two new FAQs' directly matches the PR's main change—adding two new documentation FAQ pages (OTP extraction and OracleDB configuration).
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.


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

❤️ Share

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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In
@src/pages/docs/FAQs/general/how-to-configure-the-oracledb-add-on-in-testsigma.md:
- Line 62: The example JDBC URL currently includes the password wrapped in angle
brackets; update the JDBC string
**jdbc:oracle:thin:@localhost:1521:ORCL?user=SYS&password=<123456789012>&internal_logon=SYSDBA**
to remove the brackets so the password is shown as **password=123456789012**
(i.e., replace `password=<123456789012>` with `password=123456789012`) so
placeholders remain bracketed elsewhere but actual example values are not.
📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 26f7f86 and 948612e.

📒 Files selected for processing (2)
  • src/pages/docs/FAQs/general/how-do-i-retrieve-the-otp-when-its-embedded-within-html-tags.md
  • 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-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)

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 (2)
src/pages/docs/FAQs/general/how-to-configure-the-oracledb-add-on-in-testsigma.md (1)

1-72: Overall documentation quality is strong.

The FAQ is well-structured with clear installation and configuration steps. The YAML front-matter is correct, images are appropriately referenced, and the guide provides helpful context (e.g., Service Name vs. SID notes). Consider verifying that the referenced S3 image URLs are publicly accessible and stable.

src/pages/docs/FAQs/general/how-do-i-retrieve-the-otp-when-its-embedded-within-html-tags.md (1)

1-64: Well-organized documentation with clear workflows.

The FAQ effectively guides users through extracting OTPs from HTML-embedded emails using addons and NLP actions. The structure follows a logical progression: prerequisites → addon installation → configuration steps. Steps are detailed and include helpful visual references via images. The regex pattern example (>\d{6}<) and character removal example (><) are concrete and helpful.

Verify that:

  1. The linked documentation on MailboxFunctions is current and publicly accessible.
  2. All referenced S3 image URLs are stable and publicly available.


Example URL using the screenshot details:

**jdbc:oracle:thin:@localhost:1521:ORCL?user=SYS&password=<123456789012>&internal_logon=SYSDBA**
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Remove angle brackets from password in example JDBC URL.

The example JDBC URL shows the password as <123456789012>, but angle brackets should only wrap placeholders, not actual values. Passwords should be provided without angle brackets.

🔧 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.

Suggested change
**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 example JDBC URL currently includes the password wrapped in
angle brackets; update the JDBC string
**jdbc:oracle:thin:@localhost:1521:ORCL?user=SYS&password=<123456789012>&internal_logon=SYSDBA**
to remove the brackets so the password is shown as **password=123456789012**
(i.e., replace `password=<123456789012>` with `password=123456789012`) so
placeholders remain bracketed elsewhere but actual example values are not.

@bharathk08 bharathk08 merged commit 00b2bff into dev Jan 7, 2026
4 of 5 checks passed
@bharathk08 bharathk08 deleted the DOC-497 branch January 7, 2026 09:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants