Added new docs for TS <> TMS Integration#102
Conversation
Added TS <> TMS Integration docs
WalkthroughThis pull request adds Testsigma two-way integration documentation, introduces new navigation entries in the left sidebar and nav cards, updates documentation page ordering across multiple files (incrementing order values by 1 in many sections), standardizes formatting in 404.js, and updates the Test Management index banner and feature list text. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
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: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
src/pages/docs/test-management/index.jsx (1)
34-36: UseclassNameinstead ofclassin JSXConfirmed: Lines 34-36 use the HTML
classattribute instead of React'sclassName. Additionally, inconsistent indentation and extra spacing in<hr />should be fixed.- <div class="w-full"> -<hr /> -</div> + <div className="w-full"> + <hr /> + </div>
♻️ Duplicate comments (7)
src/pages/docs/test-management/settings/labels.md (1)
6-6: ****Order field updates are consistent with settings section reordering. Verification requirements are covered in the previous comment for custom-fields.md.
src/pages/docs/test-management/settings/audit-logs.md (1)
6-6: ****Order field updates are consistent with settings section reordering. Verification requirements are covered in the previous comment for custom-fields.md.
src/pages/docs/test-management/ci-cd-integrations/jenkins.md (1)
6-6: ****Order field updates follow the same systematic pattern. Verification for complete ordering consistency is covered in the previous comment.
src/pages/docs/test-management/settings/manage-properties.md (1)
6-6: ****Order field updates follow the systematic reordering pattern. See previous verification comment for comprehensive checks.
src/pages/docs/test-management/reports/dashboard-reports.md (1)
6-6: ****Order field follows the reordering pattern. Comprehensive verification is being tracked.
src/pages/docs/test-management/ci-cd-integrations/travis-ci.md (1)
6-6: ****Order field follows the consistent reordering pattern. Verification ongoing.
src/pages/docs/test-management/settings/manage-access.md (1)
6-6: ****Order field follows the consistent reordering. Full verification scope addressed in earlier comments.
🧹 Nitpick comments (2)
src/pages/docs/test-management/testsigma-two-way-integration/execute-test-plans.md (1)
16-17: Minor nit: remove trailing space in#interactive-demoURLThere’s a trailing space in the contextual link URL (
url: '#interactive-demo'). It’s unlikely to break anything but trimming it would avoid any fragile anchor matching.src/pages/docs/test-management/testsigma-two-way-integration/link-test-cases.md (1)
17-17: Remove trailing whitespace.Line 17 contains trailing whitespace after the URL value. This is a minor formatting issue.
- url: '#interactive-demo' + url: '#interactive-demo'
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (43)
src/components/navcards.jsx(1 hunks)src/left-nav-title.json(1 hunks)src/pages/404.js(2 hunks)src/pages/docs/test-management/api-reference/modules.md(1 hunks)src/pages/docs/test-management/api-reference/overview.md(1 hunks)src/pages/docs/test-management/atto/best-practices/generating-test-cases.md(1 hunks)src/pages/docs/test-management/atto/best-practices/writing-best-prompts.md(1 hunks)src/pages/docs/test-management/atto/bug-reporter-agent/report-bugs.md(1 hunks)src/pages/docs/test-management/atto/executor-agent/download.md(1 hunks)src/pages/docs/test-management/atto/executor-agent/execute-test-runs.md(1 hunks)src/pages/docs/test-management/atto/generator-agent/generate-tests-from-clickup.md(1 hunks)src/pages/docs/test-management/atto/generator-agent/generate-tests-from-figma.md(1 hunks)src/pages/docs/test-management/atto/generator-agent/generate-tests-from-files.md(1 hunks)src/pages/docs/test-management/atto/generator-agent/generate-tests-from-images.md(1 hunks)src/pages/docs/test-management/atto/generator-agent/generate-tests-from-jira.md(1 hunks)src/pages/docs/test-management/atto/generator-agent/generate-tests-from-recording.md(1 hunks)src/pages/docs/test-management/atto/generator-agent/generate-tests-with-prompts.md(1 hunks)src/pages/docs/test-management/atto/overview.md(1 hunks)src/pages/docs/test-management/atto/sprint-planner/manage-clickup-tasks.md(1 hunks)src/pages/docs/test-management/atto/sprint-planner/manage-linear-cycles.md(1 hunks)src/pages/docs/test-management/atto/sprint-planner/manage-sprints.md(1 hunks)src/pages/docs/test-management/ci-cd-integrations/azure-devops.md(1 hunks)src/pages/docs/test-management/ci-cd-integrations/circleci.md(1 hunks)src/pages/docs/test-management/ci-cd-integrations/github.md(1 hunks)src/pages/docs/test-management/ci-cd-integrations/gitlab.md(1 hunks)src/pages/docs/test-management/ci-cd-integrations/jenkins.md(1 hunks)src/pages/docs/test-management/ci-cd-integrations/travis-ci.md(1 hunks)src/pages/docs/test-management/index.jsx(1 hunks)src/pages/docs/test-management/manage-users/invite-users.md(1 hunks)src/pages/docs/test-management/reports/create-report.md(1 hunks)src/pages/docs/test-management/reports/dashboard-reports.md(1 hunks)src/pages/docs/test-management/reports/view-reports.md(1 hunks)src/pages/docs/test-management/settings/api-keys.md(1 hunks)src/pages/docs/test-management/settings/audit-logs.md(1 hunks)src/pages/docs/test-management/settings/custom-fields.md(1 hunks)src/pages/docs/test-management/settings/labels.md(1 hunks)src/pages/docs/test-management/settings/manage-access.md(1 hunks)src/pages/docs/test-management/settings/manage-properties.md(1 hunks)src/pages/docs/test-management/testsigma-two-way-integration/connect-testsigma.md(1 hunks)src/pages/docs/test-management/testsigma-two-way-integration/execute-test-plans.md(1 hunks)src/pages/docs/test-management/testsigma-two-way-integration/link-test-cases.md(1 hunks)src/pages/docs/test-management/testsigma-two-way-integration/link-test-plans.md(1 hunks)src/pages/docs/test-management/testsigma-two-way-integration/manage-user.md(1 hunks)
⏰ 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 (40)
src/pages/docs/test-management/atto/generator-agent/generate-tests-with-prompts.md (1)
6-6: Metadata reordering for doc structure alignment.The order value increment from
11.21to12.21appears intentional to accommodate new Testsigma integration documentation. No content changes; metadata-only adjustment.src/pages/docs/test-management/atto/generator-agent/generate-tests-from-files.md (1)
6-6: Metadata reordering—consistent with doc structure updates.Order value incremented from
11.27to12.27to align with broader documentation reorganization. No content impact.src/pages/docs/test-management/atto/generator-agent/generate-tests-from-recording.md (1)
6-6: Metadata reordering for doc structure alignment.Order value incremented from
11.25to12.25as part of documentation reorganization. No content changes; metadata adjustment only.src/pages/docs/test-management/atto/generator-agent/generate-tests-from-jira.md (1)
7-7: Metadata reordering—aligned with documentation restructuring.Order value incremented from
11.22to12.22. No content changes; pure metadata adjustment for documentation navigation ordering.src/pages/docs/test-management/atto/sprint-planner/manage-sprints.md (1)
6-6: Metadata reordering for doc structure alignment.Order value incremented from
11.11to12.11to maintain documentation hierarchy during reorganization. No content changes.src/pages/docs/test-management/atto/overview.md (1)
6-6: Metadata reordering—top-level ATTO restructuring.Order value incremented from
11to12at the parent level, with corresponding child pages shifted from11.xto12.x. This hierarchical reordering appears intentional and consistent across the ATTO section.src/pages/docs/test-management/atto/best-practices/writing-best-prompts.md (1)
6-6: Metadata reordering—consistent with ATTO documentation updates.Order value incremented from
11.52to12.52. No content changes; pure metadata adjustment for documentation navigation.src/pages/docs/test-management/manage-users/invite-users.md (1)
6-6: Metadata reordering to accommodate new Testsigma integration section.Order value incremented from
10.1to11.1to shift Manage Users section down the hierarchy as new Testsigma Two-way Integration documentation is introduced. No content changes; pure metadata adjustment.src/pages/docs/test-management/atto/executor-agent/execute-test-runs.md (1)
6-6: Order value updated as part of documentation reordering.The front matter order has been incremented to accommodate new integration documentation. This change appears consistent with the broader restructuring mentioned in the PR summary.
However, I cannot fully verify that the ordering is correct without seeing the complete navigation structure (navcards.jsx, left-nav-title.json) and the new pages being added. Could you provide those files for review?
src/pages/docs/test-management/atto/generator-agent/generate-tests-from-images.md (1)
6-6: Order value incremented consistently with other documentation reordering.No content changes. This ordering aligns with the pattern observed across other files in the ATTO section.
src/pages/docs/test-management/atto/generator-agent/generate-tests-from-clickup.md (1)
7-7: Order value updated; consistent with documented reordering pattern.src/pages/docs/test-management/atto/sprint-planner/manage-clickup-tasks.md (1)
6-6: Order incremented as part of documentation restructuring.src/pages/docs/test-management/atto/sprint-planner/manage-linear-cycles.md (1)
6-6: Order value updated; no content changes.src/pages/docs/test-management/api-reference/modules.md (1)
6-6: Order incremented from 13.1 to 14.1.This suggests the entire API Reference section has been shifted. Consistent with the documented reordering; approve without seeing full context.
src/pages/docs/test-management/atto/best-practices/generating-test-cases.md (1)
6-6: Order value updated consistently.src/pages/docs/test-management/atto/bug-reporter-agent/report-bugs.md (1)
6-6: Order value incremented as part of documentation reordering.src/pages/docs/test-management/api-reference/overview.md (1)
6-6: Frontmatter order increment aligns with navigation restructuring.The order change from 13.1 to 14.1 is consistent with other Test Management docs updated in this PR and reflects the addition of new Testsigma integration content at lower order values. Contextual links remain valid.
src/pages/docs/test-management/reports/view-reports.md (1)
6-6: Frontmatter order increment is consistent with Reports section restructuring.The order change from 12.2 to 13.2 aligns with the overall documentation reordering in this PR. All internal links remain valid.
src/pages/docs/test-management/atto/generator-agent/generate-tests-from-figma.md (1)
6-6: Frontmatter order increment aligns with Atto section restructuring.The order change from 11.26 to 12.26 is consistent with other pages in this section. All documentation links remain functional.
src/pages/docs/test-management/ci-cd-integrations/azure-devops.md (1)
6-6: Frontmatter order increment is consistent with CI/CD integrations reordering.The order change from 14.2 to 15.2 aligns with the systematic reordering across all CI/CD integration docs in this PR (Jenkins 14.1→15.1, GitHub 14.3→15.3, CircleCI 14.5→15.5, GitLab 14.6→15.6, Travis CI 14.4→15.4). All links and code blocks remain intact.
src/pages/docs/test-management/reports/create-report.md (1)
6-6: Frontmatter order increment aligns with Reports section restructuring.The order change from 12.1 to 13.1 is consistent with the Reports section reordering. This is the primary report creation guide and its metadata update is appropriate.
src/pages/docs/test-management/ci-cd-integrations/github.md (1)
6-6: Frontmatter order increment is consistent with CI/CD integrations reordering.The order change from 14.3 to 15.3 aligns with the systematic reordering across all CI/CD integration docs in this PR. All GitHub Actions workflow examples and instructions remain intact.
src/pages/docs/test-management/ci-cd-integrations/gitlab.md (1)
6-6: Frontmatter order increment is consistent with CI/CD integrations reordering.The order change from 14.6 to 15.6 aligns with the systematic reordering across all CI/CD integration docs. All GitLab pipeline configuration and instructions remain intact and properly formatted.
src/pages/docs/test-management/settings/api-keys.md (1)
6-6: Frontmatter order increment aligns with Settings section restructuring.The order change from 9.4 to 10.4 is consistent with the Settings section reordering in this PR (all Settings pages increment by 1). This reflects the broader navigation restructuring to accommodate new Testsigma integration documentation.
src/pages/docs/test-management/settings/custom-fields.md (1)
6-6: Documentation ordering is correct for this change, but pre-existing duplicate order values exist elsewhere.The shift of custom-fields.md from 9.2 to 10.2 is properly aligned with the Testsigma integration pages occupying the 9.x range. However, the verification reveals three pre-existing duplicate order values in the documentation:
- order: 5.1 — appears in both
create-step-groups.mdandmanage-step-groups.md- order: 8.3 — appears in both
figma.mdandlinear.md- order: 14.1 — appears in both
modules.mdandoverview.mdThese duplicates are unrelated to this PR but should be resolved to maintain ordering coherence. The current change itself is structurally sound.
src/pages/docs/test-management/atto/executor-agent/download.md (1)
6-6: Order bump looks consistent with reorderingOnly the
ordervalue changed here; this is safe and keeps the page aligned with the new Test Management docs sequencing.src/pages/docs/test-management/ci-cd-integrations/circleci.md (1)
6-6: CircleCI doc order update is fineUpdating
orderto15.5is consistent with the broader CI/CD integration reordering and does not affect the document content.src/pages/docs/test-management/index.jsx (1)
18-25: Hero copy and tagline update read clearlyThe new heading (“Test Management Documentation & Support”), added line break, and updated action list (“SETUP | PLAN | AUTHOR | ORGANIZE | EXECUTE | REPORT”) are clear and better describe the docs scope.
src/pages/docs/test-management/testsigma-two-way-integration/manage-user.md (1)
1-91: Unified user management doc looks solidThe structure (prerequisites, interactive demo, and separate flows for adding users in Test Management by Testsigma vs Testsigma) is clear, and
contextual_linkscorrectly match the section headings. This should be straightforward for users to follow.src/pages/404.js (1)
1-54: 404 formatting cleanup is safeThe switch to single quotes, added semicolons, and JSX spacing tweaks do not change behavior; the NotFound page still renders the same content and conditional guidance.
src/components/navcards.jsx (1)
64-76: New “Testsigma Two-way Integration” and “Settings” cards look correctThe added card for “Testsigma Two-way Integration” (id 9) pointing to
/docs/test-management/testsigma-two-way-integration/connect-testsigma/and the updated “Settings” card (id 10) with a concrete path align with the new docs and improve discoverability.src/pages/docs/test-management/testsigma-two-way-integration/connect-testsigma.md (1)
1-75: Integration overview and connect flows are clearThis page cleanly explains the two-way integration, includes clear prerequisites, an interactive demo, and step-by-step enablement from both Test Management by Testsigma and Testsigma. Anchors in
contextual_linkscorrectly match the section headings.src/pages/docs/test-management/testsigma-two-way-integration/execute-test-plans.md (1)
1-89: Execute‑from‑TMS doc is comprehensive and alignedThe page clearly explains prerequisites, how executions fan out into machine‑level runs, and where to see reports, with a helpful interactive demo. Section anchors line up with
contextual_links, so in‑page navigation should work as expected.src/pages/docs/test-management/testsigma-two-way-integration/link-test-plans.md (3)
1-24: Verify order values and page_id uniqueness across documentation.The YAML frontmatter follows the established pattern. However, ensure:
- Order value
9.4aligns with the overall documentation hierarchy (especially if there's a parent section 9)- The
page_id: 'link-test-plans-in-testsigma-and-tms'is globally unique and doesn't conflict with existing page IDs
42-49: Verify external Storylane embed accessibility.The interactive demo relies on an external Storylane embed at
https://app.storylane.io/demo/tlhrchasmohp?embed=inline. Ensure:
- This URL remains accessible and the demo is up-to-date
- The embed ID (
tlhrchasmohp) is correct for the intended demo content- The Storylane service availability doesn't introduce a single point of failure for documentation
53-85: Verify all referenced product UI paths and feature names.The instructions reference specific UI elements (e.g., "Testsigma Automated Test Plan", "Test Plan Details", "Link New Plans") and navigation paths. Before publishing:
- Confirm these UI elements and paths exist in the current versions of both Test Management by Testsigma and Testsigma
- Verify that the dialog names and field labels match the actual product interfaces
- Test the workflows end-to-end to ensure accuracy
src/pages/docs/test-management/testsigma-two-way-integration/link-test-cases.md (3)
46-53: Verify external Storylane embed accessibility.The interactive demo embeds a Storylane demo at
https://app.storylane.io/demo/1glcrse4npum?embed=inline. Ensure:
- This URL is accessible and the demo accurately reflects current product workflows
- The demo ID (
1glcrse4npum) is correct- Consider the availability dependency on the external Storylane service
72-73: Verify custom callout syntax compatibility.The documentation uses a custom callout syntax
[[info | **NOTE**:]]for highlighted information boxes. Confirm:
- This syntax is recognized and correctly rendered by your documentation build system
- This matches the platform's syntax guide for info callouts
- The rendering produces the intended visual hierarchy and accessibility
Also applies to: 93-94
57-95: Verify all referenced product UI paths, features, and toggles.Before publishing, confirm:
- All UI paths and navigation flows (e.g., "Create Tests > Test Cases", "Manage Test Case") are current in both products
- Referenced UI elements and dialogs ("Link Testsigma Automated Test Case", "Link Test Case") exist with correct naming
- The "Link Multiple" toggle (line 91) exists in the Testsigma Test Case linking UI
- All step-by-step workflows have been tested end-to-end
src/left-nav-title.json (1)
176-193: All navigation entries are properly mapped to existing documentation files.Verification confirms:
- ✓ All 5 child entries correspond to actual
.mdfiles in/src/pages/docs/test-management/testsigma-two-way-integration/- ✓ No missing pages in the directory
- ✓ Parent entry
"testsigma-two-way-integration"follows the established navigation pattern (parent entries in this structure serve as category containers without requiring index files)- ✓ JSON syntax is valid
- ✓ Navigation naming conventions and hierarchical organization are consistent with existing structure
| id: 14, | ||
| title: 'API Reference', | ||
| description: | ||
| 'Get a complete view of common concepts necessary to interact with APIs successfully.', | ||
| path: '/docs/test-management/atto/overview/', | ||
| }, |
There was a problem hiding this comment.
API Reference card currently points to Atto overview
The “API Reference” card uses the same path as the Atto card:
- Atto:
/docs/test-management/atto/overview/ - API Reference:
/docs/test-management/atto/overview/(likely incorrect)
This will send users to the Atto docs instead of API docs.
Once you confirm the correct API reference location (for example, a path under /docs/test-management/api-reference/... if that exists), please update the path here accordingly.
🤖 Prompt for AI Agents
In src/components/navcards.jsx around lines 98 to 103, the "API Reference"
card's path incorrectly points to the Atto overview; update the path value to
the correct API docs route (for example replace
'/docs/test-management/atto/overview/' with the confirmed API location such as
'/docs/test-management/api-reference/' or the exact subpath you verify),
ensuring the path string matches the canonical API Reference URL used by the
docs site.
| 1. Create or open the test plan you want to execute in Test Management by Testsigma. | ||
|
|
||
| 2. In the test plan details page, under **Testsigma Automated Test Plan**, click **Link a Test Plan** if the plan is not yet linked. | ||
|
|
||
| 3. In the **Link Testsigma Automated Test Plan** dialog: | ||
| - Select the Testsigma's **Project**, **Application**, and **Version**. | ||
| - Select a **Test Plan**. | ||
| - Click **Link**. | ||
|
|
||
| 4. After linking, click the **Play icon** next to the linked **Testsigma Automated Test Plan** to trigger execution. | ||
|
|
||
| 2. After execution completes in Testsigma, Test Management by Testsigma automatically creates a test run for each machine with the associated test cases. | ||
|
|
||
| 3. Open the test run in the test plan to view execution details. The run includes links to the individual test case results pages for each executed test case. | ||
|
|
There was a problem hiding this comment.
Tighten ordered list numbering under “Execute a Linked Test Plan”
Within “Execute a Linked Test Plan in Test Management by Testsigma”, the ordered list goes 1., 2., 3., 4. and then restarts at 2. and 3.. Depending on the Markdown renderer, this may either show as 2/3 again or just be confusing when editing.
Consider renumbering the last two items to continue the sequence (e.g., 5. and 6.) or folding them into prose under the existing step 4.
🤖 Prompt for AI Agents
In
src/pages/docs/test-management/testsigma-two-way-integration/execute-test-plans.md
around lines 56 to 70, the ordered list under “Execute a Linked Test Plan in
Test Management by Testsigma” restarts numbering (1-4 then 2-3), causing
confusion; renumber the final two list items to continue the sequence (change
the duplicated `2.` and `3.` to `5.` and `6.`) or merge their content into step
4 as additional prose so the ordered list is sequential and renders correctly.
2 participants
Added new docs for TS <> TMS Integration
Testsigma Integration for Test Management by Testsigma
Managing Users in Testsigma & Test Management by Testsigma
Link Test Cases Between Test Management by Testsigma & Testsigma
Link Test Plans Between Test Management by Testsigma & Testsigma
Summary by CodeRabbit
Release Notes
New Features
Documentation
✏️ Tip: You can customize this high-level summary in your review settings.