EPMRPP-111752 || Add info about 'Change status' on Step and Log level

[pressayuliya]

Summary by CodeRabbit

• Documentation
  • Reorganized documentation page order within the reports section for improved navigation flow
  • Added new guide on manually changing status for steps and logs, including available values (Passed, Failed, Skipped) and effects on launch statistics and counters

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

[coderabbitai]

Walkthrough

Documentation files were reorganized by updating sidebar position metadata for two files, and a new section describing manual status changes for Steps and Logs was added to the ViewLaunches documentation.

Changes

Cohort / File(s)	Summary
Sidebar reordering docs/work-with-reports/LaunchesTestItemsAttributes.mdx, docs/work-with-reports/LogLevel.mdx	Updated front matter sidebar_position values (5→4 and 4→5 respectively) to reorder documentation navigation
New documentation content docs/work-with-reports/ViewLaunches.mdx	Added new section "Change Status on Step and Log level" explaining manual status changes (Passed, Failed, Skipped) for Steps and Logs, with notes on impact to launch statistics and defect type classification

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• EPMRPP-111091 || Reorganize Log level docs #1059: Modifies the same documentation files (LaunchesTestItemsAttributes.mdx, LogLevel.mdx, ViewLaunches.mdx) affecting sidebar positions and Log-level documentation organization.

Suggested reviewers

• AmsterGet
• maria-hambardzumian

Poem

🐰 The docs hop into place with grace,
Sidebar positions rearranged with care,
Status changes now clearly mapped,
From log to step, the knowledge is shared! ✨

🚥 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 pull request title accurately reflects the main change: adding documentation about the 'Change status' feature on Step and Log levels, which is the primary content addition in ViewLaunches.mdx.
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.}

✨ Finishing touches

🧪 Generate unit tests (beta)

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

---

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

[coderabbitai]

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In `@docs/work-with-reports/ViewLaunches.mdx`:
- Around line 147-150: Add a brief clarifying sentence under the "You can change
the status of a Step or Log" list explaining that the Interrupted status is not
user-settable: insert a note after the list stating something like "Note: The
Interrupted status is automatically applied by the system when test execution is
interrupted and cannot be manually set." Reference the existing list (Passed,
Failed, Skipped) and the term "Interrupted" so readers understand the
distinction.

🧹 Nitpick comments (1)

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

144-162: Tighten grammar and casing in the new status-change section.

Minor wording fixes improve clarity (Line 144, Line 160).

✍️ Suggested edit

-ReportPortal allows to manually change the execution status of Logs and Steps.
+ReportPortal allows you to manually change the execution status of logs and steps.
 ...
-Changing the status on Log or Step level affects launch statistics and aggregated counters
+Changing the status on log or step level affects launch statistics and aggregated counters

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

# First, let's examine the documentation file
head -160 docs/work-with-reports/ViewLaunches.mdx | tail -20

Repository: reportportal/docs

Length of output: 714

---

🏁 Script executed:

# Search for status definitions and validations in the codebase
rg -i "passed|failed|skipped|interrupted" --type json --type ts --type tsx --type js --type jsx -l | head -20

Repository: reportportal/docs

Length of output: 88

---

🏁 Script executed:

# Look for status enums or constants
rg -i "status.*enum|enum.*status|const.*status" --type ts --type tsx --type js -A 5

Repository: reportportal/docs

Length of output: 88

---

🏁 Script executed:

# Search for API routes or endpoints that handle status changes
rg -i "step.*status|log.*status" --type ts --type tsx --type js -l | head -15

Repository: reportportal/docs

Length of output: 88

---

🏁 Script executed:

# Search for "Interrupted" in the documentation
rg -i "interrupted" docs/

Repository: reportportal/docs

Length of output: 5669

---

🏁 Script executed:

# Look for status reference or tables that mention multiple statuses
rg -i "status.*table|status.*reference" docs/ -A 3

Repository: reportportal/docs

Length of output: 3106

---

🏁 Script executed:

# Check if there are any API documentation files mentioning status values
fd -e md -e mdx | xargs rg -l "status" | head -10

Repository: reportportal/docs

Length of output: 475

---

🏁 Script executed:

# Search for any comprehensive status documentation or tables
rg -i "passed.*failed.*skipped" docs/ -B 2 -A 2

Repository: reportportal/docs

Length of output: 25111

---

Add clarifying note that manual status changes are limited to Passed/Failed/Skipped.

The documentation correctly lists only Passed, Failed, and Skipped as manually changeable statuses for Steps and Logs. However, since Interrupted appears throughout the system (in statistics, widgets, and API responses), readers may be confused about why it's not included. Add a brief note clarifying that Interrupted is automatically set by the system and cannot be changed manually—for example: "Note: The Interrupted status is automatically applied by the system when test execution is interrupted and cannot be manually set."

🤖 Prompt for AI Agents

In `@docs/work-with-reports/ViewLaunches.mdx` around lines 147 - 150, Add a brief
clarifying sentence under the "You can change the status of a Step or Log" list
explaining that the Interrupted status is not user-settable: insert a note after
the list stating something like "Note: The Interrupted status is automatically
applied by the system when test execution is interrupted and cannot be manually
set." Reference the existing list (Passed, Failed, Skipped) and the term
"Interrupted" so readers understand the distinction.