Merge branch 'master' of github.com:makeplane/docs into new-theme

Author: srinivaspendem

README.md

@@ -1,6 +1,6 @@
 # Plane Documentation
 
-This website is built using [Docusaurus v3](https://docusaurus.io/) and hosted at [docs.plane.so](https://docs.plane.so/). If you are looking for the developer documentation, see [Plane developer documentation](https://github.com/makeplane/developer-docs).
+This website is built using [VitePress v1.6.3](https://vitepress.dev/) and hosted at [docs.plane.so](https://docs.plane.so/). If you are looking for the developer documentation, see [Plane developer documentation](https://github.com/makeplane/developer-docs).
 
 ## Overview
 
@@ -25,24 +25,24 @@ The Plane documentation provides detailed information on the following topics:
 
 3. Install dependencies.
    ```bash
-   yarn
+   pnpm install
    ```
 
 ## Local development
 
 ```bash
-yarn start
+pnpm dev
 ```
 
 This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
 
 ## Build
 
 ```bash
-yarn build
+pnpm build
 ```
 
-This command generates static files into the `build` directory.
+This command generates static files into the `docs/.vitepress/dist` directory.
 
 ## Contributing
 

docs/.vitepress/config.ts

@@ -557,7 +557,7 @@ if(n<200&&document.readyState==="loading")requestAnimationFrame(function(){bar(n
         ],
       },
       {
-        text: "Collaboration",
+        text: "Communication",
         items: [
           {
             text: "Project Updates",
@@ -571,7 +571,9 @@ if(n<200&&document.readyState==="loading")requestAnimationFrame(function(){bar(n
             text: "Page Inline Comments",
             link: "/core-concepts/pages/inline-comments",
           },
-          { text: "Inbox", link: "/core-concepts/inbox" },
+          { text: "Subscribers", link: "/communication-and-collaboration/subscribers" },
+          { text: "Notifications", link: "/communication-and-collaboration/notifications" },
+          { text: "Inbox", link: "/communication-and-collaboration/inbox" },
         ],
       },
       {

docs/automations/custom-automations.md

@@ -5,41 +5,49 @@ description: Automate repetitive project tasks in Plane.
 
 # Automations
 
-Automations handle repetitive project work so your team can focus on the work that matters. Plane offers two kinds of automations, both configured in **Project Settings → Automations**.
+Automations handle repetitive project work so your team can focus on the work that matters. Instead of manually closing stale issues, archiving completed work, or nudging assignees about deadlines, you set up rules once and let Plane run them.
 
-- **Built-in automations** are ready-to-use toggles for common housekeeping tasks — archiving closed work items, closing stale ones, and sending deadline reminders.
+There are two kinds of automations:
 
-- **[Custom automations](/automations/custom-automations)** let you build your own trigger-condition-action workflows — like auto-assigning a reviewer when a work item moves to QA, or adding a label when priority changes.
+**Default automations** come built into every project. They cover the most common housekeeping tasks — archiving completed work items, closing stale ones, and sending due date reminders — and you configure them with a single time-based setting.
+
+**Custom automations** are rules you build yourself. You choose a trigger, optionally add conditions to narrow scope, then define what happens. They run at either the project level or the workspace level. See [Custom automations](/automations/custom-automations).
 
 ![Automations](https://media.docs.plane.so/automations/automations.webp#hero)
 
-## Auto-archive closed work items
+## Set up default automations
+
+### Auto-archive completed work items
 
-Automatically archive work items that have been completed or cancelled, keeping your active views clean.
+Auto-archive moves work items that have been sitting in a completed or cancelled state into an archived state.
 
 1. Navigate to **Project Settings → Automations**.
 2. Toggle on **Auto-archive closed work items**.
 3. Set the **Auto-archive work items that are closed for** duration. Options include 1 month, 3 months, 6 months, 9 months, 12 months, or a custom time range.
 
 Once enabled, work items that have been in a completed or cancelled state for longer than the configured duration are archived automatically. Archived work items remain searchable and accessible in the project's archived view, but they no longer appear in active lists, boards, or spreadsheets.
 
-## Auto-close work items
+:::info
+Work items in active cycles or modules won't be archived even if they've been completed for longer than your threshold.
+:::
+
+### Auto-close stale work items
 
-Automatically close work items that have been inactive — not completed or cancelled — after a period you define. This prevents stale work items from cluttering your project indefinitely.
+Auto-close moves unfinished work items — those in Backlog, Unstarted, or Started states — to a closed/cancelled state after a period of inactivity. This prevents stale work items from cluttering your project indefinitely.
 
 1. Navigate to **Project Settings → Automations**.
 2. Toggle on **Auto-close work items**.
 3. Set the **Auto-close work items that are inactive for** duration — for example, 1 month.
 4. Choose the **Auto-close status** — the state that inactive work items will be moved to (e.g., Cancelled).
 
-Work items that haven't been updated within the configured period are automatically moved to the selected auto-close status. Only work items that are not already in a completed or cancelled state are affected.
+### Set up due date reminders <Badge type="warning" text="Enterprise Grid" />
 
-## Auto-reminders
-
-Send automatic reminders via email and in-app notifications to keep your team on track with deadlines. When a work item's due date is approaching, assignees receive a reminder so nothing slips through the cracks.
+Plane sends in-app and email notifications to assignees and subscribers when a work item's due date is approaching.
 
 1. Navigate to **Project Settings → Automations**.
 2. Toggle on **Auto-reminders**.
 3. Set the **Send reminder before** timing — for example, 3 days before the due date.
 
-Once enabled, assignees and work item subscribers receive both an email and an in-app notification at the configured interval before each work item's due date. Only work items with a due date and at least one assignee or subscriber trigger reminders.
+Only work items with a due date and at least one assignee or subscriber trigger reminders.
+
+Plane sends one reminder per window — not a daily flood. If you've set a 3-day reminder and the due date is 3 days away, each person gets one notification.

docs/automations/overview.md

@@ -0,0 +1,92 @@
+---
+title: Notifications Inbox
+description: Learn how to use Plane's notifications inbox — filter by type, mark as read, snooze, archive, and use stacked notifications to quickly catch up on work item activity.
+---
+
+# Inbox
+
+The Inbox is a space for tracking and managing updates to work items you're connected with. Whether you're assigned to a work item, its creator, mentioned in a discussion, or subscribed to its updates, you'll find everything here. It's where all your in-app notifications live.
+
+The inbox has two tabs: **All** and **Mentions**. Each tracks its own unread count. The sidebar icon shows a red dot when either tab has unread notifications.
+
+## Where to find Inbox
+
+Click the **Notifications** icon in the top right of the screen to open the inbox. Clicking a notification opens the work item in a panel on the right — you stay in the inbox.
+
+![Inbox](https://media.docs.plane.so/inbox/inbox.webp#hero)
+
+Use the **All** tab for everything except @-mentions — state changes, field updates, comments, assignments. Use the **Mentions** tab to see only notifications where someone @-tagged you.
+
+::: tip Email notifications
+All inbox notifications are also sent to your email by default. You can [customize your email notification preferences](/communication-and-collaboration/notifications#set-your-notification-preferences) in Profile Settings.
+:::
+
+### Manage notifications in your inbox
+
+Hover over any notification card to reveal three action buttons:
+
+- **Mark read / unread** — toggles the unread indicator
+- **Archive** — removes it from your default view; you can still find archived notifications by turning on Show archived in the menu
+- **Snooze** — hides it until a time you choose
+
+To clear everything at once, use **Mark all as read** in the inbox header.
+
+### Filter your notifications
+
+Use the **filter icon** to narrow by type — you can combine multiple filters:
+
+- **Assigned to me** — notifications for work items where you're an assignee
+- **Created by me** — notifications for work items you created
+- **Subscribed by me** — notifications for items you're subscribed to but didn't create or get assigned to
+
+Use the **three-dot menu** to toggle display options — only one can be active at a time:
+
+- **Show unread** — only unread notifications
+- **Show archived** — only archived notifications
+- **Show snoozed** — only snoozed notifications, including ones whose snooze time has already passed
+
+Active filters appear as tags below the tab bar. Remove them individually or clear all at once.
+
+## Notification card content
+
+Each notification card shows:
+
+- **Who did it** — the actor's avatar (or a bell icon for due date reminders)
+- **What they did** — a one-line summary, e.g. "Alice added assignee Bob" or "Carol set due date to Jan 15"
+- **Which work item** — the project identifier and sequence number, and the work item name
+- **When** — a relative timestamp, e.g. "3 hours ago"
+- **Unread dot** — a small coloured dot on the left edge when unread
+- **Snoozed indicator** — if snoozed, the timestamp is replaced with "Till {date}, {time}"
+
+## Snooze options
+
+| Option  | Hides until               |
+| ------- | ------------------------- |
+| 1 day   | Tomorrow at the same time |
+| 3 days  | Three days from now       |
+| 5 days  | Five days from now        |
+| 1 week  | One week from now         |
+| 2 weeks | Two weeks from now        |
+| Custom  | A date and time you pick  |
+
+## Stacked notifications <Badge type="info" text="Pro" />
+
+Notifications are grouped by work item. Instead of one card per event, you get one card per work item covering all the changes to it.
+
+The stacked card shows:
+
+- The work item name and identifier
+- Avatars of everyone who made changes
+- An unread count badge for the group
+- The time of the most recent notification
+
+Hovering over a stacked card opens a preview showing all the individual changes inside it — each one with the actor, what changed, and when.
+
+Clicking a stacked card marks all grouped notifications as read and, in full-page view, opens the work item with the relevant activity items scrolled into view and highlighted. The highlight fades after 5 seconds.
+
+Actions on a stacked card — read/unread, archive, snooze — apply to all notifications in the group at once.
+
+## See also
+
+- [Subscribers](/communication-and-collaboration/subscribers)
+- [Notifications](/communication-and-collaboration/notifications)

docs/communication-and-collaboration/inbox.md

@@ -0,0 +1,103 @@
+---
+title: Notifications
+description: Understand what triggers notifications in Plane, how in-app, email, and push notifications work, how to set your notification preferences, and how stacked emails reduce inbox noise.
+---
+
+# Notifications
+
+Notifications are how Plane tells you something changed on a work item you care about. Every time a tracked change happens, Plane builds a list of people who should know — subscribers, assignees, and the creator — and sends them a notification.
+
+There are three channels: in-app inbox, email, and push (mobile). You can control which events send you emails.
+
+## Set your notification preferences
+
+You can control which types of changes send you email notifications — you don't have to receive emails for everything.
+
+1. Go to **Profile Settings → Notifications**.
+2. Toggle on or off:
+   - **Property changes** — assignee, label, priority, due date, and other field changes
+   - **State changes** — when a work item moves to a different state
+   - **Issue completed** — specifically when a work item reaches a completed state (sub-toggle under state changes)
+   - **Comments** — new or updated comments
+   - **Mentions** — when someone @-mentions you
+
+These preferences apply across your whole workspace — there's no per-project setting. Changes save immediately.
+
+Inbox notifications always come through regardless of these settings. These toggles only affect emails.
+
+## Events that trigger notifications
+
+| Event                                                             | Notifies?                                                            |
+| ----------------------------------------------------------------- | -------------------------------------------------------------------- |
+| Work item created                                                 | Yes                                                                  |
+| Any field updated (state, priority, assignee, label, dates, etc.) | Yes                                                                  |
+| Comment added                                                     | Yes                                                                  |
+| Comment edited                                                    | Yes                                                                  |
+| Comment deleted                                                   | Yes                                                                  |
+| Link added, updated, or removed                                   | Yes                                                                  |
+| Attachment added or removed                                       | Yes                                                                  |
+| Work item relation added or removed (blocked by, duplicate, etc.) | Yes                                                                  |
+| Work item deleted                                                 | Yes                                                                  |
+| @mention in description or comment                                | Yes (mention notification)                                           |
+| Epic field updated                                                | Yes                                                                  |
+| Epic update published (progress or status post)                   | Yes — all epic subscribers get an email                              |
+| Due date approaching (reminder)                                   | Yes — subscribers and assignees get an in-app and email notification |
+
+## Notification channels
+
+| Channel       | When it fires                           | Can be turned off?                |
+| ------------- | --------------------------------------- | --------------------------------- |
+| Inbox         | Every tracked event                     | No                                |
+| Email         | Tracked events, batched every 5 minutes | Yes, via notification preferences |
+| Push (mobile) | Every tracked event                     | Yes                               |
+
+Emails are batched — they don't go out the instant something changes. Plane groups pending email notifications and sends them every 5 minutes.
+
+## Batched email notifications
+
+Plane doesn't send one email per change. Multiple changes to the same work item are grouped into a single email, sent every 5 minutes. If someone updates the priority, changes the state, and adds a comment in quick succession, you get one email covering all three — not three separate ones.
+
+This means there's always a short delay before an email arrives, but it also means your email inbox doesn't fill up when a work item goes through a burst of activity.
+
+## Who gets notified
+
+For each change, Plane notifies:
+
+- Everyone subscribed to the work item
+- All current assignees
+- The person who created the work item
+
+The person who made the change is excluded — you don't get notified about your own actions.
+
+If someone is @-mentioned in the same activity, they get a mention notification specifically, not an additional subscriber notification.
+
+## Notification preferences
+
+These settings live in **Profile Settings → Notifications** and apply globally across all your projects.
+
+| Preference       | What it controls                                                                                 |
+| ---------------- | ------------------------------------------------------------------------------------------------ |
+| Property changes | Emails for any field update (assignee, label, priority, dates, etc.)                             |
+| State changes    | Emails when a work item moves to a different state                                               |
+| Issue completed  | Emails specifically when a work item reaches a completed state (sub-setting under state changes) |
+| Comments         | Emails for new or updated comments                                                               |
+| Mentions         | Emails when you are @-mentioned                                                                  |
+
+Turning off a preference stops the email — it does not stop the in-app notification.
+
+## The difference between inbox and email notifications
+
+In-app notifications always come through — your notification preferences don't affect them. They accumulate in the Inbox panel and you can read, snooze, or archive them from there.
+
+Email notifications are the ones you can control. Your preferences in Profile Settings let you decide which types of changes are worth an email. If you want in-app pings for everything but only emails for comments and mentions, you can set that up.
+
+## Due date reminders
+
+Due date reminders are a special notification type configured at the project level (in Project Settings → Automations). When enabled, Plane sends a notification to both the work item's subscribers and its assignees when the due date is within the configured window — say, 3 days out.
+
+These are one-time per window. If you've set a 3-day reminder and someone already received it, they won't get another one until the window resets. Reminders only go out for work items that are still in progress — completed and cancelled items are skipped. See [Set up due date reminders](/automations/overview#set-up-due-date-reminders).
+
+## See also
+
+- [Subscribers](/communication-and-collaboration/subscribers)
+- [Inbox](/communication-and-collaboration/inbox)