diff --git a/website/docs/artist_inbox.md b/website/docs/artist_inbox.md new file mode 100644 index 00000000..82914b6b --- /dev/null +++ b/website/docs/artist_inbox.md @@ -0,0 +1,55 @@ +--- +id: artist_inbox +title: Inbox and Notifications +sidebar_label: Inbox and Notifications +--- + +:::info +The inbox was introduced in `1.2.0`. +::: + +![Inbox overview](./assets/inbox/inbox_important.png) + +### Overview + +The inbox is an email-inspired feature that consolidates all your updates and notifications across AYON. Designed for more than just listing notifications, it serves as a hub of organization and prioritization. With two tabs, "Important" and "Other," it ensures that crucial messages don't get lost in the production noise. Related notifications, such as multiple messages about the same folder, are grouped together for better clarity. + +Think of the inbox as a dynamic to-do list for tasks that require your attention. You can mark messages as read to revisit them later, or clear them once you're done to keep your workflow organized. + +:::tip +The inbox has full keyboard support! Hover over any message and press `X` to mark it as read/unread or `C` to clear/unclear. +::: + +### Important VS Other + +Currently, what qualifies as "Important" or "Other" is pre-set. However, future updates will allow you to customize the importance of messages. + +**Important** + +- You are directly mentioned in the comment. For example: `Looks great @Felix Peterson`. +- You are assigned to or removed from a task. + +**Other** + +- You are removed from a task. +- New activity on entities you are assigned to or have authored, including: + - Comments + - Status changes + - Assignee changes + +### Realtime Notifications + +Enable browser push notifications to stay aware of new important inbox messages. You can activate these notifications from the inbox or your account profile page. + +You can also enable notification sounds for added awareness. + +![Turn on notifications](./assets/inbox/inbox_enable.png) +![Turn on notifications in account](./assets/inbox/notifications_account_settings.png) + +:::tip +Desktop notifications and notification sounds work independently to one another. +::: + +:::warning +Desktop notifications will not work over HTTP connections due to strict browser security measures. +::: diff --git a/website/docs/assets/inbox/inbox_enable.png b/website/docs/assets/inbox/inbox_enable.png new file mode 100644 index 00000000..a6251de1 Binary files /dev/null and b/website/docs/assets/inbox/inbox_enable.png differ diff --git a/website/docs/assets/inbox/inbox_important.png b/website/docs/assets/inbox/inbox_important.png new file mode 100644 index 00000000..bde72605 Binary files /dev/null and b/website/docs/assets/inbox/inbox_important.png differ diff --git a/website/docs/assets/inbox/notifications_account_settings.png b/website/docs/assets/inbox/notifications_account_settings.png new file mode 100644 index 00000000..7662e82a Binary files /dev/null and b/website/docs/assets/inbox/notifications_account_settings.png differ diff --git a/website/sidebars.js b/website/sidebars.js index 13a97935..ab604867 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -84,7 +84,7 @@ module.exports = { type: "category", collapsed: false, label: "Production Tracking", - items: ["artist_my_tasks_page", "artist_activity_feed"], + items: ["artist_my_tasks_page", "artist_activity_feed", "artist_inbox"], }, ], Admin: [