docs: refresh alerts guide for new New-alert IA + state model#2038
Open
strawgate wants to merge 6 commits into
Open
docs: refresh alerts guide for new New-alert IA + state model#2038strawgate wants to merge 6 commits into
strawgate wants to merge 6 commits into
Conversation
Aligns the alerts walkthrough with the redesigned UI: - The Create-alert flow now goes through a New-alert picker (Custom query / Service Level Objective / Templates), not a direct "Create alert" button. - Document the new "When this alert fires" section (Fire when + Look at rows from + Check every) and drop the obsolete Webhook URL paragraph that lived inside the create form. - Replace the Alert History section with overview-level descriptions of the state tiles (Firing / Flapping / OK / Snoozed / No data), the activity bar chart, the sparkline tooltip semantics, and the Group by / search controls. - Add a Snoozing section explaining the deadlines, bulk snooze, and that snoozed alerts halt both evaluation and delivery. - Rewrite the Edit-an-alert section around the new detail page (status callout + Setup card + Runs history), and rename the section header to "The Alerts overview" so it actually matches what users see.
- browser-alerts-new.png — new file: the New alert picker (Custom query / SLO / Templates) introduced in the platform redesign. - browser-alerts-create.png — refreshed for the new Create alert form (Environments above Query, Sample queries dropdown, new Description helper). - browser-alerts-full.png — refreshed for the new Alerts overview chrome (empty state shown; populated screenshots can land in a follow-up once telemetry is available).
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
1 issue found across 1 file
Confidence score: 4/5
- In
docs/guides/web-ui/alerts.md, the anchor#notification-channelspoints to a non-existent section, so readers will hit a dead link and may miss setup guidance; update the link to#notification-modesor add a matching## Notification channelsheading before merging.
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="docs/guides/web-ui/alerts.md">
<violation number="1" location="docs/guides/web-ui/alerts.md:42">
P2: Broken anchor link: `#notification-channels` doesn't exist in the file. Add a `## Notification channels` section or change the link to `#notification-modes`.</violation>
</file>
Reply with feedback, questions, or to request a fix.
Re-trigger cubic
…bits only) - browser-alerts-full.png: hero — populated overview with state tiles, activity chart, and a mix of OK + Snoozed alerts. Shipped at a tighter 1152px-wide viewport so it doesn't dominate the docs page. - browser-alerts-new.png: New alert picker (Custom query / SLO / Templates) — visualizes the IA decision a user makes first. - browser-alerts-create.png: full Create form with the "When this alert fires" disclosure open, so the page documents the trigger + cadence model rather than just generic form chrome. - browser-alerts-edit.png: alert detail page with the Status callout showing the snoozed deadline + Unsnooze action, plus the Setup card. Drop browser-alerts-no-error.png, browser-alerts-error.png, browser-alerts-parameters.png, browser-alerts-create-alert.png, and browser-alerts-create-channel.png — the docs no longer reference them and they showed the old UI.
The previous hero showed "No firings in this window" — useless for a docs page trying to communicate what alerts are for. The new shot has: - Activity chart with red bars across the recent 8 buckets. - State tiles showing the spread (Flapping 2 / OK 1 / Snoozed 1). - Per-row sparklines showing the firing pattern on each alert (Auth failures and Slow database queries flapping, HTTP 4xx spike OK after a sustained recent fire). Mock data was seeded into logfire.alert_runs on local dev for the screenshot; the in-product chart query is unchanged.
Snooze mutes delivery only — evaluation keeps running on schedule and the
Runs history records what fires during the mute. The prior wording ("pauses
both evaluation and notifications") described a design that was considered
and rejected in favor of Option B, so users who read this doc would be
misled about what history they'll see during a snooze window.
Also drops the dangling '#notification-channels' anchor (there is no such
section on the page — it read as a promised list that never appears) and
corrects the Next-run column wording to match what the UI actually shows
(*disabled* rather than *paused*).
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Aligns the alerts walkthrough with the platform redesign shipping in pydantic/platform#feat/alerts-page-and-polish.
Screenshots in the guide still show the old UI; they'll be refreshed once the platform PR ships.
Test plan