Skip to content

Commit b93e596

Browse files
authored
feat: Docs for Notifications feature (#866)
1 parent 1491d71 commit b93e596

File tree

6 files changed

+61
-0
lines changed

6 files changed

+61
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
id: notifications
3+
title: Notifications
4+
sidebar_label: Notifications
5+
---
6+
7+
import { ScreenshotWrapper } from "../shared/_ScreenshotWrapper";
8+
9+
Notifications keep you up to date with everything important that you should not miss.
10+
11+
A notification is created when:
12+
13+
* Your password is changed.
14+
* Multi-factor authentication is enabled or disabled for your account.
15+
* A task is assigned to you (if tasks are enabled).
16+
* A task you created is closed or completed (if tasks are enabled).
17+
18+
There are two types of notifications:
19+
20+
* In-app notifications
21+
* Email notifications
22+
23+
Notifications can be disabled in the settings.
24+
By default, all notifications are enabled.
25+
26+
## In-app Notifications
27+
28+
<ScreenshotWrapper src="/img/docs/platform/notifications/notifications.webp"
29+
alt="Notifications bell"/>
30+
31+
In-app notifications can be viewed by clicking the bell icon in the top right corner of the screen.
32+
33+
The number on the bell icon indicates the count of unseen notifications.
34+
35+
<ScreenshotWrapper src="/img/docs/platform/notifications/notifications_popup.webp"
36+
alt="Notifications pop-up"/>
37+
38+
Clicking a notification redirects you to the relevant page, such as the associated task.
39+
40+
In-app notifications can be disabled in the settings.
41+
42+
## Email Notifications
43+
44+
If enabled, email notifications are sent to the user's registered email address.
45+
46+
<ScreenshotWrapper src="/img/docs/platform/notifications/notifications_email.webp"
47+
alt="Notifications email"/>
48+
49+
Email notifications can be disabled in the settings.
50+
51+
## Notification Settings
52+
53+
Notifications can be enabled or disabled per type and channel.
54+
55+
The settings page can be found in the account settings.
56+
57+
Security notifications are always enabled.
58+
59+
<ScreenshotWrapper src="/img/docs/platform/notifications/notifications_settings.webp"
60+
alt="Notification settings"/>

sidebarPlatform.js

+1
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ module.exports = {
5050
'translation_process/comments',
5151
'translation_process/icu_message_format',
5252
'translation_process/tolgee_universal_icu_placeholders',
53+
'translation_process/notifications',
5354
],
5455
},
5556
{
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.

0 commit comments

Comments
 (0)