Skip to content

Restructure Error Reporting Releases docs into a Project Releases section - #3711

Open
karansharmasauce wants to merge 1 commit into
mainfrom
docs/project-releases
Open

karansharmasauce wants to merge 1 commit into
mainfrom
docs/project-releases

Conversation

@karansharmasauce

Copy link
Copy Markdown
Collaborator

Description

Restructures the Error Reporting Releases documentation into a dedicated Project Releases section that matches the current Releases view in the Backtrace Web Console.

  • Overview: Rewrites web-console/releases.md as the Project Releases overview. It covers how to open the Releases view, the three parts of the page (controls, health charts, and compare groups table), and links to the new pages. The page keeps its existing id, so the /error-reporting/web-console/releases/ URL and the link from What's New still work.
  • New pages under docs/error-reporting/project-releases/:
    • Configuring Release Views: choose the error type, set the version attribute, select up to four releases to compare, and filter the view.
    • Check Release Health Metrics: the User adoption, Error-free application launches, Errors over time, and New errors over time charts.
    • Stability Metrics Table: each column in the compare groups table, triage status and percentage metrics, and opening a release in Triage.
  • Sidebar: Adds a Project Releases category after MCP, with the overview first, and removes Releases from Web Console Views.
  • Screenshots: Adds new screenshots under static/img/error-reporting/project-releases/, grouped into one subfolder per page.

Motivation and Context

The existing Releases page described an older version of the UI, such as pencil-icon dialogs for choosing the version attribute and releases. It also still carried an October 2021 note saying the User adoption and session stability charts were planned, even though both charts now exist. These changes bring the docs in line with the current dropdown-based UI, document all four health charts, and split the content into focused pages, following the structure of the Triage, Explore, and MCP sections.

Types of Changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation fix (typos, incorrect content, missing content, etc.)

@github-actions

github-actions Bot commented Oct 8, 2026

Copy link
Copy Markdown

Deploy preview ready for 3711!
https://docs.dev.saucelabs.net/pr-preview/pr-3711

This branch has not been deployed

No deployments
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.

1 participant