Skip to content

Add Desktop app#473

Merged
danciaclara merged 4 commits into
masterfrom
desktop-app
Jul 15, 2026
Merged

Add Desktop app#473
danciaclara merged 4 commits into
masterfrom
desktop-app

Conversation

@danciaclara

@danciaclara danciaclara commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

Description

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • Feature (non-breaking change which adds functionality)
  • Improvement (change that would cause existing functionality to not work as expected)
  • Code refactoring
  • Performance improvements
  • Documentation update

Screenshots and Media (if applicable)

Test Scenarios

References

Summary by CodeRabbit

  • Documentation
    • Added comprehensive documentation for the Plane desktop app, including installation, system requirements, sign-in, instance management (including switching/resetting), updates, deep links, and core usage.
    • Expanded the Devices documentation navigation to include separate Mobile and Desktop entries.

@vercel

vercel Bot commented Jul 15, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Jul 15, 2026 11:30am

Request Review

@coderabbitai

coderabbitai Bot commented Jul 15, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@danciaclara, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 51 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 8fba438d-a7f7-451b-9d1a-eefb2415f9f1

📥 Commits

Reviewing files that changed from the base of the PR and between 53de797 and 9095647.

📒 Files selected for processing (1)
  • docs/devices/desktop.md
📝 Walkthrough

Walkthrough

Adds a complete Plane desktop app documentation page covering setup, connectivity, usage, updates, and platform behavior, and links it from the Devices sidebar alongside the Mobile page.

Changes

Desktop documentation

Layer / File(s) Summary
Devices sidebar navigation
docs/.vitepress/config.ts
The Devices sidebar now links to separate Mobile and Desktop pages.
Desktop app setup and access
docs/devices/desktop.md
Documents system requirements, installation, instance connection, sign-in behavior, and OAuth configuration.
Desktop app operation and lifecycle
docs/devices/desktop.md
Documents tabs, windows, notifications, menus, resets, updates, compatibility, deep links, and differences from the web app.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the main change: adding documentation and config for the Desktop app.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch desktop-app

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/devices/desktop.md`:
- Line 6: Update the page heading in desktop.md to match the existing Desktop
sidebar label from the docs configuration, preserving the heading’s meaning and
changing only the capitalization/text needed for an exact match.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: b1fa1d45-56fb-4b47-b948-13b55398bb86

📥 Commits

Reviewing files that changed from the base of the PR and between f997859 and e4a43ed.

📒 Files selected for processing (2)
  • docs/.vitepress/config.ts
  • docs/devices/desktop.md

Comment thread docs/devices/desktop.md Outdated
Comment thread docs/devices/desktop.md
- **macOS**
- **Linux**

To connect to a self-managed deployment, the instance must be on **Plane Commercial v3.0.0 or later**. Earlier versions do not support the desktop app.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should also note that they need to be using desktop app version 3.0.0 or later.

Comment thread docs/devices/desktop.md
Comment thread docs/devices/desktop.md
Comment thread docs/devices/desktop.md Outdated
- **Open a new tab** with the **+** button at the end of the tab bar, or **New tab** (Cmd/Ctrl+T).
- **Close a tab** with the **X** on the tab, or **Close tab** (Cmd/Ctrl+W). You cannot close the last remaining tab in a window.
- **Reorder tabs** by dragging them along the tab bar.
- **Go back and forward** using the arrows to the left of the tabs.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It’s not there yet; we have Ctrl+Tab or Ctrl+Shift+Tab for tab switching.

Comment thread docs/devices/desktop.md
@prateekshourya29

Copy link
Copy Markdown
Member

Doc follow-ups (from review) + OAuth desktop callbacks (shipped in product)

Building on the inline notes on this PR, here’s a short summary of what would be good to add or clarify in docs/devices/desktop.md (and related self-managed / auth docs where it fits).

Suggested doc additions / corrections

  1. Version floors (both sides)

    • Instance: Plane Commercial v3.0.0+ (already mentioned).
    • Desktop app: also desktop app v3.0.0 or later when connecting to self-managed.
  2. Updates are instance-bound
    Auto-update does not always mean “latest desktop build.” The app upgrades/downgrades to a version compatible with the connected instance (not a free-floating latest). Worth a short note under download/install or automatic updates. (Internal context: Slack.)

  3. OAuth / SSO redirect URIs for self-managed (admin setup)
    Same class of setup as mobile: if the instance uses Google / GitHub / GitLab / Gitea, admins must register desktop callback URIs in the OAuth app (God Mode → Authentication → each provider → Desktop section).
    Paths (origin = instance URL):

    • /auth/desktop/google/callback/
    • /auth/desktop/github/callback/
    • /auth/desktop/gitlab/callback/
    • /auth/desktop/gitea/callback/
      SAML / OIDC / LDAP remain unsupported on desktop (as already drafted). A short “Admin: configure OAuth for desktop” subsection under Signing in to a self-managed instance would close the gap.
  4. Tabs
    Prefer documenting Ctrl+Tab / Ctrl+Shift+Tab for next/previous tab (and drop or fix any claim that isn’t shipped yet).

  5. Contextual tab icons
    Worth a line under tabs: tab bar icons reflect the current page/context (project logo, work item type, etc.) so open tabs are easier to tell apart.

What we did in product (for cross-link)

God Mode now surfaces those desktop callback URIs next to Web / Mobile / Admin, mirroring the mobile pattern—so self-managed admins can copy-paste without digging through API routes.

Once that ships, this docs PR can reference it (and optionally the God Mode Authentication screens) so the OAuth self-managed steps stay accurate for desktop, not only mobile.

Happy to expand any of these into full draft copy if useful.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
docs/devices/desktop.md (1)

18-22: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Include Windows in the supported-systems list.

The introduction says the app supports macOS, Windows, and Linux, but this requirements list omits Windows. Add it so Windows users are not incorrectly told the app is unsupported.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/devices/desktop.md` around lines 18 - 22, Update the supported-systems
list in the desktop app introduction to include Windows alongside macOS and
Linux, matching the documented platform support.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/devices/desktop.md`:
- Line 88: Update the tab shortcut bullet in the desktop documentation to
describe switching to the next/previous tab, replacing the misleading “Go back
and forward” label while preserving the existing Ctrl+Tab and Ctrl+Shift+Tab
shortcuts.

---

Outside diff comments:
In `@docs/devices/desktop.md`:
- Around line 18-22: Update the supported-systems list in the desktop app
introduction to include Windows alongside macOS and Linux, matching the
documented platform support.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: d4fc73d0-d4d0-4685-bacf-1766f77bdaf8

📥 Commits

Reviewing files that changed from the base of the PR and between e4a43ed and 53de797.

📒 Files selected for processing (1)
  • docs/devices/desktop.md

Comment thread docs/devices/desktop.md
- **Open a new tab** with the **+** button at the end of the tab bar, or **New tab** (Cmd/Ctrl+T).
- **Close a tab** with the **X** on the tab, or **Close tab** (Cmd/Ctrl+W). You cannot close the last remaining tab in a window.
- **Reorder tabs** by dragging them along the tab bar.
- **Go back and forward** Ctrl+Tab / Ctrl+Shift+Tab for next/previous tab.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Describe tab switching, not history navigation.

Ctrl+Tab and Ctrl+Shift+Tab switch between tabs, but “Go back and forward” suggests browser history navigation and conflicts with the table below. Rename this bullet to “Switch to the next/previous tab.”

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/devices/desktop.md` at line 88, Update the tab shortcut bullet in the
desktop documentation to describe switching to the next/previous tab, replacing
the misleading “Go back and forward” label while preserving the existing
Ctrl+Tab and Ctrl+Shift+Tab shortcuts.

@danciaclara danciaclara merged commit 7e65131 into master Jul 15, 2026
5 checks passed
@danciaclara danciaclara deleted the desktop-app branch July 15, 2026 12:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants