Skip to content

QUA-1806: Document scan-triggered status changes in anomaly history#1122

Open
RafaelOsiro wants to merge 2 commits into
mainfrom
qua-1806-anomaly-lifecycle-history-fixes
Open

QUA-1806: Document scan-triggered status changes in anomaly history#1122
RafaelOsiro wants to merge 2 commits into
mainfrom
qua-1806-anomaly-lifecycle-history-fixes

Conversation

@RafaelOsiro

@RafaelOsiro RafaelOsiro commented May 19, 2026

Copy link
Copy Markdown
Contributor

Warning

This PR depends on userguide#1121 getting merged first.

Overview

Documents the anomaly history entries emitted when a scan changes an anomaly's status through Auto Resolve Anomalies or Reactivate Recurring Anomalies, attributing them to Qualytics and (for Auto Resolve) linking back to the originating scan. Also mentions assignee changes in the History events list and applies light style polish to the Description note (em-dash removal plus trailing periods).

Key Changes

  • History scan attribution: new !!! note admonition under Anomaly Insights → History documenting Qualytics attribution and the scan link for Auto Resolve / Reactivate Recurring Anomalies status changes.
  • Recorded events list: adds assignee changes alongside status changes, description edits, and tag updates.
  • Style polish: two em-dashes removed (Description note and Unlinking a Ticket paragraph) and trailing periods added to the two bullets inside the Description note.

Pages to Test

Adds an admonition under Anomaly Insights → History explaining that
Auto Resolve Anomalies and Reactivate Recurring Anomalies status
changes are attributed to Qualytics, with Auto Resolve entries
linking back to the scan. Also mentions assignee changes in the
recorded events list and removes two em-dashes (Description note
and Unlinking a Ticket paragraph).
@RafaelOsiro RafaelOsiro added the documentation Improvements or additions to documentation label May 19, 2026
@RafaelOsiro RafaelOsiro self-assigned this May 19, 2026
@greptile-apps

greptile-apps Bot commented May 19, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR adds documentation for scan-triggered anomaly status changes in the History section, attributing them to Qualytics and linking Auto Resolve entries back to their originating scan. It also applies style polish across two sections by removing em-dashes and adding trailing periods to bullets.

  • History note added: a new !!! note admonition directly under the History section image documents that status changes via Auto Resolve Anomalies or Reactivate Recurring Anomalies are attributed to Qualytics, with Auto Resolve entries linking back to the triggering scan.
  • Recorded events list updated: assignee changes is now listed alongside status changes, description edits, and tag updates in the History section paragraph.
  • Style fixes: em-dashes in the Description note and Unlinking a Ticket paragraph are replaced with sentence breaks; both bullets in the Description !!! note now end with a period.

Confidence Score: 5/5

Documentation-only change with no runtime logic; all edits are accurate prose updates safe to merge.

The PR touches a single Markdown file, adds one new admonition block, updates two prose paragraphs, and applies minor punctuation fixes. There are no code paths, logic branches, or external dependencies that could regress. The previous review comment about missing trailing periods on both bullets has been fully addressed in this revision.

No files require special attention.

Important Files Changed

Filename Overview
docs/anomalies/details/insights.md Documentation-only update: adds scan-triggered history attribution note, includes assignee changes in recorded events list, replaces two em-dashes with sentence breaks, and adds trailing periods to both description-note bullets.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Scan runs] --> B{Status change?}
    B -- Auto Resolve Anomalies --> C[Anomaly status → Resolved]
    B -- Reactivate Recurring Anomalies --> D[Anomaly status → Active]
    C --> E[History entry: attributed to **Qualytics** + link to scan]
    D --> F[History entry: attributed to **Qualytics**]
    E --> G[User views History section]
    F --> G
Loading

Reviews (2): Last reviewed commit: "docs(anomalies): add trailing periods to..." | Re-trigger Greptile

Comment thread docs/anomalies/details/insights.md Outdated
@shindiogawa shindiogawa marked this pull request as draft May 26, 2026 17:38
@RafaelOsiro RafaelOsiro marked this pull request as ready for review June 3, 2026 17:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant