Skip to content

Commit e37d256

Browse files
Merge pull request #472 from dappnode/pablo-mateu/add-user-notis-section
[WIP] Add notifications section to user docs
2 parents e68c7ed + e5b4c3b commit e37d256

File tree

10 files changed

+141
-0
lines changed

10 files changed

+141
-0
lines changed

docs/user/notifications/inbox.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# 📨 Notifications Inbox
2+
3+
In the inbox section, you will see new notifications and the complete history.
4+
To understand how notifications work, there are several key characteristic to consider:
5+
6+
- **New notification**: Unread notification that will show at the top of the history.
7+
- **History**: Notifications seen previously
8+
- **Priority**: Importance level of the notification: Informational, Relevant, Important and Critical
9+
- **Informational** – Awareness only; no action is needed.
10+
- **Relevant** – Action is recommended but not urgent.
11+
- **Important** – Prompt action is strongly advised.
12+
- **Critical** – Immediate action is required.
13+
- **Status**: Two notification status: `Triggered` when the notification is active and it is sent, and `Resolved` when the event notified is back to normal.
14+
- **Category**: There are different notifications categories: Hardware, System, Ethereum, Lukso, Gnosis and Hoodi. You can filter the notifications by category.
15+
- **Banner**: It is shown at the top of the UI for urgent notices.
16+
- **Filter:** You can filter notifications in the search bar by Package name (`DnpName`) Title and keywords.
17+
18+
![Notifications_inbox](/img/notifications_inbox.png)

docs/user/notifications/legacy.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Notifications Legacy
2+
3+
In the legacy section you have access to the previous system of notifications with email and telegram. The aim of the new notification system is to unify the notifications in a single channel in desktop and mobile to facilitate the user experience and be more reliable, configurable and scalable. Therefore, this section will be deprecated in the upcoming core releases.
4+
5+
![Notifications_legacy](/img/notifications_legacy.png)
6+
7+
### The Notification system will evolve continuously
8+
We hope the new notification system will help you to have a 360º tracking of your Dappnode and staking activity. New notifications will be added to improve your monitoring continuously.
9+
10+
If you have feedback to improve the new notifications, let us know all your ideas in Discord.
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# List of Notifications
2+
3+
This is the full list of events that will be notified in your Dappnode.
4+
5+
### 🛠️ System Notifications
6+
7+
- Auto-updates (core and non-core packages)
8+
- Repository health (IPFS, Ethereum)
9+
- Host password security
10+
- Wi-Fi password security
11+
- Static IP address changes
12+
- Host reboot required
13+
- Disk usage warnings
14+
- Package stoppages due to system limits
15+
- No internet connection
16+
17+
### 📊 DMS (Dappnode Monitoring Service)
18+
19+
- Memory usage
20+
- CPU load
21+
- Disk usage
22+
- Device temperature
23+
24+
### ⚙️ Execution Clients
25+
26+
- Sync status
27+
- Peer count
28+
29+
### ⚖️ Consensus Clients
30+
31+
- Sync status
32+
- Peer count
33+
34+
### 📡 Direct Notifications
35+
36+
- Important messages from the Dappnode team
37+
38+
And more notifications of your validators are coming soon!
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Notifications Overview
2+
3+
Dappnode Notifications is a built-in system that keeps you informed about important events and updates across your Dappnode setup. Whether it's a new software release, a hardware warning, or a consensus sync alert — notifications are your go-to source for staying up to date.
4+
5+
Notifications are package-based, meaning each package can send its own alerts. To receive notifications, you have the Notifications package installed by default and running on your Dappnode.
6+
7+
### Benefits
8+
9+
### 🖥️ Monitor Your Hardware and System in one channel
10+
11+
Get real-time alerts about your system health: CPU load, disk space, temperature, and more.
12+
It’s like having all the information about your Dappnode and staking setup in one place running 24/7.
13+
14+
### ⚙️ Customization for Every Package
15+
16+
You can fine-tune notification settings per package, including the thresholds that triggers different alerts in the package.
17+
18+
### 📬 Direct communication from the Dappnode Team
19+
20+
Receive **direct messages** from the Dappnode team for critical network events like chain forks or urgent updates (e.g. the Pectra fork). This aims to stay ahead and take action before it’s too late.
21+
22+
### How to Access Notifications
23+
24+
### 🔔 Bell Icon
25+
26+
Find the **bell icon** at the top right corner of your Dappmanager. Click it to view new or past notifications. The bell icon will show a blue dot when new notifications are triggered.
27+
28+
### 📚 Side Menu
29+
30+
You’ll also find a dedicated **Notifications** section in the side menu.
31+
![Notifications-access](/img/notifications_access.png)
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# 🛠️ Notifications Settings
2+
3+
In the settings section you can configure the type of notification you would like to receive per package.
4+
5+
🧩 **Notifications master switch:** Enable/disable all notifications.
6+
7+
**📦 Package-Level Configuration**
8+
9+
- Package Switch: Enable/disable notifications in the **package**
10+
- Customize which types of notifications are active
11+
- Set thresholds with a **slider** (e.g., temperature limit before alert)
12+
13+
![Notifications_settings](/img/notifications_settings.png)

sidebars.js

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -401,6 +401,37 @@ const sidebars = {
401401
},
402402
],
403403
},
404+
{
405+
type: "category",
406+
label: "Notifications",
407+
items: [
408+
{
409+
type: "doc",
410+
label: "Overview",
411+
id: "user/notifications/overview",
412+
},
413+
{
414+
type: "doc",
415+
label: "Notifications List",
416+
id: "user/notifications/notifications-list",
417+
},
418+
{
419+
type: "doc",
420+
label: "Inbox",
421+
id: "user/notifications/inbox",
422+
},
423+
{
424+
type: "doc",
425+
label: "Settings",
426+
id: "user/notifications/settings",
427+
},
428+
{
429+
type: "doc",
430+
label: "Legacy",
431+
id: "user/notifications/legacy",
432+
},
433+
],
434+
},
404435
{
405436
type: "category",
406437
label: "Ethical metrics",
139 KB
Loading

static/img/notifications_inbox.png

413 KB
Loading
199 KB
Loading
167 KB
Loading

0 commit comments

Comments
 (0)