Repository navigation
feat: say when a summary is longer than the toast will show - #5
Merged
Merged
Conversation
The dashboard shows an alert in a toast, not the banner this repository's README still described, and it clamps the summary to three lines on desktop and two on a phone. Everything else — the alert panel, the "Report a Bug" interstitial, the overlay's support panel and the card on this site — shows it whole, so a long summary is correct everywhere and under-read in the one place most people meet an incident. Nothing enforces that, and nothing should: prose length must never hold up a status page mid-incident. So the build prints a note past 200 characters and still exits 0, and the README says what the surfaces actually are, to lead with the symptom, and to leave the workaround to its own field, since every surface that shows the summary renders that directly beneath it. Also drops a doubled article from the missing-field errors, which read "needs a an id". Co-authored-by: Claude Opus 5 <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
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.
The dashboard shows a service alert in a toast, which clamps the summary to three lines on desktop and two on a phone. This repository's README still described a banner, and told whoever writes an announcement that the summary is "shown in the dashboard banner" — so nothing told them that the first sentence is the only part most readers see.
Forward-looking only: the live OBS incident is untouched, and the generated
alerts.jsonis byte-identical to what is serving now.The build notes an over-long summary, and still succeeds. Past 200 characters it prints the file, the length and what to do about it, then exits 0. A failure would be wrong here — prose length must never be the thing that holds up a status page mid-incident. Verified: a short summary draws no note, a missing one still fails with exit 1 and writes nothing.
The README says what the surfaces actually are. A new "Writing a summary" section: lead with the symptom in a sentence that stands on its own, keep the workaround out of it (every surface that shows the summary renders
workarounddirectly beneath it, so a fix written into both reads twice), and leave the long version to the body. The "What reads this" table now lists the toast and the alert panel instead of a banner, with a line on which one a press opens where.Also: missing-field errors read "needs a an id", from a template that added an article the field names already had.