Skip to content

Docs: describe the failure line a widget shows - #42

Merged
SandObserver merged 1 commit into
mainfrom
docs/widget-failure-messages
Sep 7, 2026
Merged

SandObserver merged 1 commit into
mainfrom
docs/widget-failure-messages

Conversation

@SandObserver

Copy link
Copy Markdown
Owner

Summary
The app stopped composing a widget's error text from the service's own message. A widget now keeps its layout, fades what it was showing, and puts one line named after the kind of failure where its own labels are. An empty result stays at full brightness and is drawn differently from a failure.

  • Correct three places that quoted strings the app no longer produces: Not configured is now Not set up yet, Bad token is now Key rejected, and there is no Unavailable.
  • Rewrite the "briefly shows Unavailable" entry to describe the dimmed state and the empty state, and point it at the new table.
  • Add "Messages a widget shows": the seven failure lines plus No data, each with its meaning and where to look. The existing table covers admin messages only, so these had nowhere to resolve to.
  • Note the Disk health widget's per-bay Not reporting state.
  • Re-sync the embedded widget code and ui/js so the previews run the current version.

Testing
npm run build and npm run check both pass. Checked in Chrome against the production build on the preview server, in both colour schemes and both docs themes. Verified every preview still renders: all 19 preview iframes have their data and config stubs, none shows a failure line, and the disk, backup, now-playing and weather previews were confirmed by eye. The night weather preview correctly takes the light caption ink while the two day previews take the dark one.

Checklist

  • npm run build and npm run check both pass.
  • Product UI is shown by running or capturing it, never recreated in CSS.
  • Any new preview or screenshot carries no private hostnames or real data.
  • Visual changes verified in both colour schemes and both docs themes.
  • Links to the app repo still resolve.

The app no longer composes a widget's error text from the service's own
message. It shows one line named after the kind of failure, and an empty
result is drawn differently from a failed one.

Correct the three places that quoted the old strings, and add a table of the
lines a widget can show, with where to look for each. Re-sync the embedded
widget code so the previews run the current version.
@SandObserver SandObserver added the documentation Improvements or additions to documentation label Sep 7, 2026
@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying stackyard-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: f87d200
Status: ✅  Deploy successful!
Preview URL: https://bd2559a0.stackyard-docs.pages.dev
Branch Preview URL: https://docs-widget-failure-messages.stackyard-docs.pages.dev

View logs

@SandObserver
SandObserver merged commit 4c53f81 into main Sep 7, 2026
2 checks passed
@SandObserver
SandObserver deleted the docs/widget-failure-messages branch September 8, 2026 01:01
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