EPMRPP-108903 || Update docs based on users' search queries

[maria-hambardzumian]

Summary by CodeRabbit

• Documentation
  • Enhanced retries documentation with step-by-step visual guidance and clearer navigation instructions.
  • Refined test item editing documentation with more specific guidance on description and attribute modifications.
  • Improved launch filtering documentation with visual illustrations and clearer instructions for using the "Latest Launches" option.

[coderabbitai]

Walkthrough

This PR updates three documentation files with improved guidance and visual aids. Changes include adding step-by-step navigation for retries discovery, clarifying test item editing instructions, refining launch filtering documentation, and incorporating supporting images and illustrations.

Changes

Cohort / File(s)	Summary
Retries Documentation docs/developers-guides/RetriesReporting.mdx	Added visual and textual guidance with images for locating retries (Launch with retries, Step level, Log page); reworded Log view reference to "Log page of test item" and included LogPage.png illustration
Launches Operations Documentation docs/work-with-reports/OperationsUnderLaunches.mdx	Clarified guidance to specify editing test descriptions and attributes rather than general test item editing; adjusted navigation context from item-level to launch-level drilling
Launches Filtering Documentation docs/work-with-reports/ViewLaunches.mdx	Replaced optimization paragraph with concise filter instruction; added MediaViewer illustration; refined dropdown label formatting (from backslash to forward slash); clarified "Latest Launches" option behavior with unique names and increment numbering

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Verify accuracy of rewording and technical terminology consistency across all three documentation files
• Confirm referenced images (LogPage.png) and MediaViewer illustrations are properly embedded and accessible
• Cross-check that navigation and UI element descriptions match current product interface

Possibly related PRs

• EPMRPP-108583 || Add application limits to documentation + releases upd #1006: Modifies the same documentation files (ViewLaunches.mdx and OperationsUnderLaunches.mdx), potential for conflicting changes

Suggested reviewers

• AmsterGet

Poem

🐰✨ Hops through the docs with images bright,
Guiding lost souls through retries' light,
Filter launches, clarify test editing ways,
Clearer pathways through the portal's maze! 📚🎯

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The pull request title "Update docs based on users' search queries" is directly related to the changeset, which consists of updates to three documentation files (RetriesReporting.mdx, OperationsUnderLaunches.mdx, and ViewLaunches.mdx). The title clearly conveys the main objective: updating documentation based on user feedback from search queries. While the title doesn't specify which documentation sections were changed or the exact nature of each improvement (adding visual guidance, updating filter instructions, etc.), these are implementation details rather than the primary change. The title successfully communicates the core intent to a teammate scanning the history.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch EPMRPP-108903

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3782006 and 24379cc.

⛔ Files ignored due to path filters (4)

• docs/developers-guides/img/retry/LaunchRetries.png is excluded by !**/*.png
• docs/developers-guides/img/retry/LogPage.png is excluded by !**/*.png
• docs/developers-guides/img/retry/StepLevelRetries.png is excluded by !**/*.png
• docs/work-with-reports/img/view-launches/FilterLatestRun.png is excluded by !**/*.png

📒 Files selected for processing (3)

• docs/developers-guides/RetriesReporting.mdx (1 hunks)
• docs/work-with-reports/OperationsUnderLaunches.mdx (1 hunks)
• docs/work-with-reports/ViewLaunches.mdx (1 hunks)

🔇 Additional comments (4)

docs/developers-guides/RetriesReporting.mdx (2)

26-26: Wording clarification enhances specificity.

Changing "On the Log view" to "On the Log page of test item" (line 26) provides clearer context about where users should look for the retry switcher. This improves UX documentation clarity.

---

14-28: Enhanced step-by-step guidance with visual aids improves discoverability.

The addition of sequential navigation steps (lines 14–20) with supporting MediaViewer images effectively guides users through locating retries. All referenced image files have been verified to exist:

• ✓ LaunchRetries.png
• ✓ StepLevelRetries.png
• ✓ RetrySwitch.png
• ✓ LogPage.png

This aligns well with the PR objective of improving documentation based on user search queries.

docs/work-with-reports/OperationsUnderLaunches.mdx (1)

40-40: Wording refinements clarify navigation scope and editing targets.

Line 40 now specifies editing "description of tests in ReportPortal or edit attributes," providing clearer intent. Line 43 changes navigation target from "any item" to "any launch," which better scopes the action within the launches hierarchy and aligns with section context.

Also applies to: 43-43

docs/work-with-reports/ViewLaunches.mdx (1)

57-61: Code changes improve documentation clarity with proper visual support.

The restructure (lines 57–61) enhances usability by replacing prose with direct instructions followed by a visual component. The clarified explanation on line 61 explicitly defines what "Latest Launches" displays. The required image asset has been verified to exist at docs/work-with-reports/img/view-launches/FilterLatestRun.png.

---

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 and usage tips.}