docs: Document Widget error handling on the Dashboard#803
docs: Document Widget error handling on the Dashboard#803promptless-for-oss wants to merge 8 commits into
Conversation
Add a new Widget error handling section that explains the graceful degradation behavior when a Widget fails to load. This documents that individual Widget errors no longer crash the entire Dashboard page.
|
|
||
| Widget error handling | ||
| ********************* | ||
|
|
There was a problem hiding this comment.
Documented Widget error handling behavior from PR #15989 which wraps widget content generation in DashboardModel::populateWidgetContent() with try/catch to display generic error messages on failing widgets while other widgets continue loading.
Source: mautic/mautic#15989
adiati98
left a comment
There was a problem hiding this comment.
@promptless-for-oss please address the suggestions.
- Wrap the intro paragraph in .. vale off / .. vale on per maintainer suggestion - Change 'check' to 'review' to satisfy [Google.WordList] - Wrap the note paragraph in .. vale off / .. vale on per maintainer suggestion
|
Thanks for the review, @adiati98! I've applied all three suggestions:
Vale now passes with 0 errors and 0 warnings on the file. Pushed to the branch. |
escopecz
left a comment
There was a problem hiding this comment.
I'd close this. The PR improves error handling. That's nothing a user needs to know. It just works.
|
Thanks @escopecz — agreed. Closing this. The Widget error-handling improvement is transparent to users: a failing Widget shows a generic message while the rest of the Dashboard keeps loading, with details logged server-side. There's no new workflow, configuration, or action for users, and the previous crash behavior was never documented — so there's nothing docs need to cover here. |
Open this suggestion in Promptless to view citations and reasoning process
Documents the graceful degradation behavior when a Widget encounters an error, based on the bug fix in PR #15989.
Changes
docs/dashboard/dashboard.rst
Context
PR #15989 fixes a bug where a single Widget exception would crash the entire Dashboard with a 500 error. The Dashboard is the default landing page, so this could make the UI completely inaccessible. Now Widget errors are caught, logged server-side, and the failing Widget shows a generic translatable error message while other Widgets continue rendering normally.
Trigger Events
Tip: Request one-off documentation tasks in the Dashboard under New Task 🚀