Updated Zephyr test management doc

[bharathk08]

Summary by CodeRabbit

• Documentation
  • Updated the Zephyr Cloud integration guide to ask for a Zephyr Project ID when linking a Zephyr Test Plan to a Testsigma Test Plan.

[coderabbitai]

📝 Walkthrough

Walkthrough

A single word change in the Zephyr integration documentation updates the linking instruction to ask users to enter the Zephyr Project ID instead of the Zephyr test plan ID.

Changes

Zephyr Integration Doc Fix

Layer / File(s)	Summary
Linking instruction wording src/pages/docs/integrations/test-management/zephyr.md	Line 79 updated to instruct users to enter the Zephyr Project ID when linking a Zephyr test plan to a Testsigma test plan.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

• testsigmahq/testsigma-docs#837: Adds the initial Zephyr Cloud integration docs page — the same file modified in this PR.
• testsigmahq/testsigma-docs#838: Also modifies the linking step wording in the same Zephyr integration doc file.

Poem

🐇 A hop, a skip, one word replaced,
The Project ID now properly placed.
No test plan ID shall confuse thee more,
The docs ring true as never before.
A tiny fix, but clear and bright! ✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title is relevant and clearly points to the Zephyr documentation update, though it is somewhat broad.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch DOC-1936

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[coderabbitai]

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/integrations/test-management/zephyr.md (1)

73-80: 📐 Maintainability & Code Quality | 🟠 Major | ⚡ Quick win

Terminology inconsistency between steps.

Step 1 instructs users to "Get the ID of an existing test plan from Zephyr Cloud," but Step 3 now asks for "Zephyr Project ID." If the integration UI field label changed to "Project ID," Step 1 should likely be updated to match (e.g., "Get the Project ID from Zephyr Cloud"). Also verify whether the screenshot (Zephyr_Plan_ID.png) still reflects the current UI label.

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@src/pages/docs/integrations/test-management/zephyr.md` around lines 73 - 80,
Update the Zephyr linking instructions so the terminology is consistent: in the
Zephyr integration doc section for linking a test plan, align Step 1 with the
field name used in the Testsigma UI by changing the reference from the generic
test plan ID to the Zephyr Project ID if that is the current label. Also review
the screenshot reference in the same “Link a Zephyr Test Plan to a Testsigma
Test Plan” section to ensure it matches the current UI wording and replace it if
outdated.

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Outside diff comments:
In `@src/pages/docs/integrations/test-management/zephyr.md`:
- Around line 73-80: Update the Zephyr linking instructions so the terminology
is consistent: in the Zephyr integration doc section for linking a test plan,
align Step 1 with the field name used in the Testsigma UI by changing the
reference from the generic test plan ID to the Zephyr Project ID if that is the
current label. Also review the screenshot reference in the same “Link a Zephyr
Test Plan to a Testsigma Test Plan” section to ensure it matches the current UI
wording and replace it if outdated.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: d681792f-5d65-4e31-b300-a551d914d292

📥 Commits

Reviewing files that changed from the base of the PR and between 11461e1 and 8fe1ac6.

📒 Files selected for processing (1)

• src/pages/docs/integrations/test-management/zephyr.md