Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Production Tracking: Inbox page #187

Merged
merged 1 commit into from
Jun 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 55 additions & 0 deletions website/docs/artist_inbox.md
Original file line number Diff line number Diff line change
@@ -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.
:::
Binary file added website/docs/assets/inbox/inbox_enable.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added website/docs/assets/inbox/inbox_important.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -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: [
Expand Down
Loading