Skip to content

Commit da4d106

Browse files
committed
[docs] Simplified web & email notifications preferences page
Less is more.
1 parent 1e09179 commit da4d106

File tree

1 file changed

+20
-17
lines changed

1 file changed

+20
-17
lines changed

docs/user/web-email-notifications.rst

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -14,33 +14,34 @@ OpenWISP Notifications sends web notifications to recipients through
1414
Django's admin site. The following components facilitate browsing web
1515
notifications:
1616

17-
Notification Widget
18-
~~~~~~~~~~~~~~~~~~~
17+
Widget
18+
~~~~~~
1919

2020
.. figure:: https://raw.githubusercontent.com/openwisp/openwisp-notifications/docs/docs/images/notification-widget.gif
2121
:target: https://raw.githubusercontent.com/openwisp/openwisp-notifications/docs/docs/images/notification-widget.gif
2222
:align: center
2323

24-
A JavaScript widget has been added to make consuming notifications easy
25-
for users. The notification widget provides the following features:
24+
The OpenWISP admin includes a notifications widget with the following
25+
features:
2626

27-
- User Interface to help users complete tasks quickly.
28-
- Dynamically loads notifications with infinite scrolling to prevent
29-
unnecessary network requests.
30-
- Option to filter unread notifications.
27+
- Infinite scroll to load notifications dynamically and smoothly.
28+
- Button to mark all as read.
3129
- Button to edit :doc:`notification-preferences`.
3230

33-
Notification Toasts
34-
~~~~~~~~~~~~~~~~~~~
31+
Toasts
32+
~~~~~~
3533

3634
.. figure:: https://raw.githubusercontent.com/openwisp/openwisp-notifications/docs/docs/images/notification-toast.gif
3735
:target: https://raw.githubusercontent.com/openwisp/openwisp-notifications/docs/docs/images/notification-toast.gif
3836
:align: center
3937

40-
Notification toast delivers notifications in real-time, allowing users to
41-
read notifications without opening the notification widget. A notification
42-
bell sound is played each time a notification is displayed through the
43-
notification toast.
38+
Notification toasts display messages in real time, so users can read them
39+
without opening the widget. A bell sound plays each time a toast is shown.
40+
41+
To prevent overload, an anti-storm mechanism temporarily disables toasts
42+
when many notifications arrive in a short time. Refer to
43+
:ref:`openwisp_notifications_notification_storm_prevention` for more
44+
information.
4445

4546
.. _notifications_email_notifications:
4647

@@ -65,9 +66,11 @@ Email Batches
6566
:align: center
6667

6768
Batching email notifications helps manage the flow of emails sent to
68-
users, especially during periods of increased alert activity. By grouping
69-
emails into batches, the system minimizes the risk of emails being marked
70-
as spam and prevents inboxes from rejecting alerts due to high volumes.
69+
users, especially during periods of increased alert activity.
70+
71+
By grouping emails into batches, the system minimizes the risk of emails
72+
being marked as spam and prevents inboxes from rejecting alerts due to
73+
high volumes.
7174

7275
Key aspects of the batch email notification feature include:
7376

0 commit comments

Comments
 (0)