Update mobile page#474
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 WalkthroughWalkthroughThe mobile app documentation is rewritten to cover updated requirements and sign-in guidance, revised navigation, mobile work areas, notifications, iOS widgets and shortcuts, privacy, and offline syncing. ChangesMobile documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 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/mobile.md`:
- Line 74: Correct the user-visible typo in the Home section sentence by
changing “youy profile” to “your profile,” leaving the surrounding documentation
unchanged.
- Around line 102-134: Update the documentation references in the “Work on the
go” section to use inline Markdown links with each destination inside
parentheses, including Work items, Comments and mentions, Cycles, Modules,
Pages, Intake, and Plane AI, while preserving their existing labels and paths.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| - **Projects** <br/> | ||
| This screen shows all the projects you have access to, along with your role and the active work items count. Tap the star icon to add a project to your **Favorites** for quick access. | ||
| ### Home | ||
| Home mirrors the web and is organized into sections you can rearrange or hide (tap Manage widgets icon next to youy profile to customize). |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Fix the typo in “your profile.”
youy is user-visible documentation text and should be corrected to your.
🧰 Tools
🪛 LanguageTool
[grammar] ~74-~74: Ensure spelling is correct
Context: ...r hide (tap Manage widgets icon next to youy profile to customize). - Your work — as...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🤖 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/mobile.md` at line 74, Correct the user-visible typo in the Home
section sentence by changing “youy profile” to “your profile,” leaving the
surrounding documentation unchanged.
Source: Linters/SAST tools
| ## Work on the go | ||
| The mobile app supports the core of your day-to-day work. Each area links to its full documentation. | ||
|
|
||
| - **Profile** <br/> | ||
| View your profile and manage your account here. You can also switch between workspaces or log out of the app from this screen. | ||
| ### Work items | ||
|
|
||
| <div class="mobile-img-container"> | ||
| <div class="box"> | ||
| <img src="https://media.docs.plane.so/mobile/app-inbox.webp" alt="Inbox" width="320"/> | ||
| </div> | ||
| <div class="box"> | ||
| <img src="https://media.docs.plane.so/mobile/app-profile.webp" alt="Profile" width="320"/> | ||
| </div> | ||
| </div> | ||
| Create work items and edit their title, description, state, priority, assignees, labels, and start/due dates. Open a work item to manage its sub-items, attachments, and relations. | ||
| See [Work items][/core-concepts/issues/overview]. | ||
|
|
||
| ### Global search | ||
| ### Comments and mentions | ||
|
|
||
| At the top of the Home screen, you’ll find the global search bar, which helps you quickly find projects, work items, cycles, modules, or pages. It's a powerful tool to jump right to what you need. | ||
| Comment on any work item and @mention teammates to notify them. React to comments. Comments and mentions sync across web and mobile. | ||
| See [Comments and mentions][/communication-and-collaboration/comments-and-activity]. | ||
|
|
||
| ### Switch workspaces | ||
| ### Cycles and modules | ||
|
|
||
| To switch between different workspaces, simply tap your workspace icon in the top-right corner or navigate to your profile settings at the bottom right of the screen. | ||
| View cycles and modules, open them to see their work items, and add or move work items between them. | ||
| See [Cycles][/core-concepts/cycles] and [Modules][/core-concepts/modules]. | ||
|
|
||
| ## Track projects | ||
| ### Pages | ||
|
|
||
| Stay on top of your work by tracking all your project's elements with ease: | ||
| Read and edit pages in the mobile editor, with rich-text formatting, images, and more. | ||
| See [Pages][/core-concepts/pages/overview]. | ||
|
|
||
| 1. Tap the **Projects** icon in the bottom navigation bar. | ||
| 2. Select the project you want to track. | ||
| ### Intake | ||
|
|
||
| You will notice that the bottom navigation bar now shows different buttons: | ||
| Review and manage incoming work items from intake. | ||
| See [Intake][/intake/overview]. | ||
|
|
||
| - **Work items** <br/> | ||
| View a list of all, active and backlog work items. | ||
| - You can search, sort, and filter work items using the icon buttons on the top right. | ||
| ### Plane AI (Pi) | ||
|
|
||
| - Tap any work item to view or modify work item details and view the activity. You can also add comments, copy the link, and share the work item with a personalized message via other apps. | ||
| When AI is enabled for your workspace, use the Pi assistant to chat, ask questions, and work with AI threads from the app. | ||
| See [Plane AI][/ai/plane-ai]. | ||
|
|
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Use normal Markdown link syntax for the documentation references.
These links use [label][destination] syntax without corresponding reference definitions, so they will not be clickable. Convert each to inline links such as [Work items](/core-concepts/issues/overview).
Proposed fix
-See [Work items][/core-concepts/issues/overview].
+See [Work items](/core-concepts/issues/overview).
-See [Comments and mentions][/communication-and-collaboration/comments-and-activity].
+See [Comments and mentions](/communication-and-collaboration/comments-and-activity).
-See [Cycles][/core-concepts/cycles] and [Modules][/core-concepts/modules].
+See [Cycles](/core-concepts/cycles) and [Modules](/core-concepts/modules).
-See [Pages][/core-concepts/pages/overview].
+See [Pages](/core-concepts/pages/overview).
-See [Intake][/intake/overview].
+See [Intake](/intake/overview).
-See [Plane AI][/ai/plane-ai].
+See [Plane AI](/ai/plane-ai).📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ## Work on the go | |
| The mobile app supports the core of your day-to-day work. Each area links to its full documentation. | |
| - **Profile** <br/> | |
| View your profile and manage your account here. You can also switch between workspaces or log out of the app from this screen. | |
| ### Work items | |
| <div class="mobile-img-container"> | |
| <div class="box"> | |
| <img src="https://media.docs.plane.so/mobile/app-inbox.webp" alt="Inbox" width="320"/> | |
| </div> | |
| <div class="box"> | |
| <img src="https://media.docs.plane.so/mobile/app-profile.webp" alt="Profile" width="320"/> | |
| </div> | |
| </div> | |
| Create work items and edit their title, description, state, priority, assignees, labels, and start/due dates. Open a work item to manage its sub-items, attachments, and relations. | |
| See [Work items][/core-concepts/issues/overview]. | |
| ### Global search | |
| ### Comments and mentions | |
| At the top of the Home screen, you’ll find the global search bar, which helps you quickly find projects, work items, cycles, modules, or pages. It's a powerful tool to jump right to what you need. | |
| Comment on any work item and @mention teammates to notify them. React to comments. Comments and mentions sync across web and mobile. | |
| See [Comments and mentions][/communication-and-collaboration/comments-and-activity]. | |
| ### Switch workspaces | |
| ### Cycles and modules | |
| To switch between different workspaces, simply tap your workspace icon in the top-right corner or navigate to your profile settings at the bottom right of the screen. | |
| View cycles and modules, open them to see their work items, and add or move work items between them. | |
| See [Cycles][/core-concepts/cycles] and [Modules][/core-concepts/modules]. | |
| ## Track projects | |
| ### Pages | |
| Stay on top of your work by tracking all your project's elements with ease: | |
| Read and edit pages in the mobile editor, with rich-text formatting, images, and more. | |
| See [Pages][/core-concepts/pages/overview]. | |
| 1. Tap the **Projects** icon in the bottom navigation bar. | |
| 2. Select the project you want to track. | |
| ### Intake | |
| You will notice that the bottom navigation bar now shows different buttons: | |
| Review and manage incoming work items from intake. | |
| See [Intake][/intake/overview]. | |
| - **Work items** <br/> | |
| View a list of all, active and backlog work items. | |
| - You can search, sort, and filter work items using the icon buttons on the top right. | |
| ### Plane AI (Pi) | |
| - Tap any work item to view or modify work item details and view the activity. You can also add comments, copy the link, and share the work item with a personalized message via other apps. | |
| When AI is enabled for your workspace, use the Pi assistant to chat, ask questions, and work with AI threads from the app. | |
| See [Plane AI][/ai/plane-ai]. | |
| ## Work on the go | |
| The mobile app supports the core of your day-to-day work. Each area links to its full documentation. | |
| ### Work items | |
| Create work items and edit their title, description, state, priority, assignees, labels, and start/due dates. Open a work item to manage its sub-items, attachments, and relations. | |
| See [Work items](/core-concepts/issues/overview). | |
| ### Comments and mentions | |
| Comment on any work item and `@mention` teammates to notify them. React to comments. Comments and mentions sync across web and mobile. | |
| See [Comments and mentions](/communication-and-collaboration/comments-and-activity). | |
| ### Cycles and modules | |
| View cycles and modules, open them to see their work items, and add or move work items between them. | |
| See [Cycles](/core-concepts/cycles) and [Modules](/core-concepts/modules). | |
| ### Pages | |
| Read and edit pages in the mobile editor, with rich-text formatting, images, and more. | |
| See [Pages](/core-concepts/pages/overview). | |
| ### Intake | |
| Review and manage incoming work items from intake. | |
| See [Intake](/intake/overview). | |
| ### Plane AI (Pi) | |
| When AI is enabled for your workspace, use the Pi assistant to chat, ask questions, and work with AI threads from the app. | |
| See [Plane AI](/ai/plane-ai). |
🧰 Tools
🪛 markdownlint-cli2 (0.23.0)
[warning] 108-108: Reference links and images should use a label that is defined
Missing link or image reference definition: "/core-concepts/issues/overview"
(MD052, reference-links-images)
[warning] 113-113: Reference links and images should use a label that is defined
Missing link or image reference definition: "/communication-and-collaboration/comments-and-activity"
(MD052, reference-links-images)
[warning] 118-118: Reference links and images should use a label that is defined
Missing link or image reference definition: "/core-concepts/cycles"
(MD052, reference-links-images)
[warning] 118-118: Reference links and images should use a label that is defined
Missing link or image reference definition: "/core-concepts/modules"
(MD052, reference-links-images)
[warning] 123-123: Reference links and images should use a label that is defined
Missing link or image reference definition: "/core-concepts/pages/overview"
(MD052, reference-links-images)
[warning] 128-128: Reference links and images should use a label that is defined
Missing link or image reference definition: "/intake/overview"
(MD052, reference-links-images)
[warning] 133-133: Reference links and images should use a label that is defined
Missing link or image reference definition: "/ai/plane-ai"
(MD052, reference-links-images)
🤖 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/mobile.md` around lines 102 - 134, Update the documentation
references in the “Work on the go” section to use inline Markdown links with
each destination inside parentheses, including Work items, Comments and
mentions, Cycles, Modules, Pages, Intake, and Plane AI, while preserving their
existing labels and paths.
Sources: Coding guidelines, Linters/SAST tools
nirmal0707
left a comment
nirmal0707
left a comment
There was a problem hiding this comment.
If we're keeping a Projects section, can we also add sections for Wiki and AI? Or we can just mention all three under the Home section.
| :::warning | ||
| You cannot create a new account from the mobile app. You must already belong to at least one workspace. If you are new to Plane, sign up on the web first, then sign in on mobile. | ||
| ::: |
There was a problem hiding this comment.
Can remove this. Onboarding is available on mobile now.
| ## Navigate the app | ||
| ## Switching workspaces | ||
|
|
||
| To switch between different workspaces, simply tap your workspace icon in the top left corner and switch between them from the workspace switcher. Your data, projects, and notifications update to reflect the selected workspace. |
There was a problem hiding this comment.
Can we mention the workspace icon on the home page to make it clearer?
| - **Home** <br/> | ||
| Your dashboard includes a search box and familiar sections like **Your Work** and **Favorites**. There’s also a **Jump back in** section to easily access your recent projects, cycles, modules, pages, and work items. | ||
| ### Create | ||
| Tap the central **+ Create** button to add new content from anywhere. Depending on your role and enabled features, you can create a project, work item, a page, or a sticky. |
There was a problem hiding this comment.
Instead of "central", we can say "floating" since it's called the Floating Action Button
| This screen shows all the projects you have access to, along with your role and the active work items count. Tap the star icon to add a project to your **Favorites** for quick access. | ||
| ### Home | ||
| Home mirrors the web and is organized into sections you can rearrange or hide (tap Manage widgets icon next to youy profile to customize). | ||
| - Your work — assigned and recent items |
There was a problem hiding this comment.
Your work — assigned work items and pages you have created
| ### Projects | ||
| Your projects are reached from within Home. Open a project to see its Work items, Cycles, Modules, and Pages. Tap the star icon to add it to Favorites. |
There was a problem hiding this comment.
The Projects section on Home now refers to the Project product (like on the web), not the list of projects anymore. We can add a Products section inside Home (above the current sections) that includes Projects (always enabled), Wiki, and AI.
| ### Managing notification preferences | ||
|
|
||
| <div class="mobile-img-container"> | ||
| <div class="box"> | ||
| <img src="https://media.docs.plane.so/mobile/app-cycles.webp" alt="Cycles" width="320" /> | ||
| </div> | ||
| <div class="box"> | ||
| <img src="https://media.docs.plane.so/mobile/app-modules.webp" alt="Modules" width="320" /> | ||
| </div> | ||
| </div> | ||
| <br /> | ||
| Control which notifications you receive from your notification settings in the app. Adjust these to reduce noise or focus only on what matters most to you. |
There was a problem hiding this comment.
Can we add a "Coming Soon" badge or something similar, since it isn't available yet but will be soon?
|
|
||
| ## Push notifications | ||
| ### The Inbox | ||
| Open the Inbox tab to read notifications and tap to jump to the item; mark as read, snooze, archive, and filter (e.g. unread only). Your inbox stays in sync across mobile and web. |
There was a problem hiding this comment.
Snoozing and archiving aren't available now, but the filters to view snoozed and archived items are available.
| ## Home-screen widgets and shortcuts (iOS) | ||
| On iOS/iPadOS, add Plane widgets for one-tap capture: Create Work Item and Create Page. You can also long-press the app icon for Quick Actions. | ||
| > Home-screen widgets are not available on Android yet. |
There was a problem hiding this comment.
It would be good to mention that more Home Screen widgets are coming soon. Also, Android widgets will be available soon.
| Feature availability also depends on your plan. Features such as Wiki and AI capabilities appear in the app only when they are enabled for your workspace. | ||
|
|
||
| ## Privacy and security | ||
| - Privacy Screen - blurs the app's contents in the app switcher and background so sensitive work isn't visible in previews. |
There was a problem hiding this comment.
For this, we need to enable the Privacy Screen in Profile.
|
|
||
| ## Privacy and security | ||
| - Privacy Screen - blurs the app's contents in the app switcher and background so sensitive work isn't visible in previews. | ||
| - Device integrity - Plane doesn't run on jailbroken or rooted devices. |
There was a problem hiding this comment.
Also, let's add a "Secure Storage" point and mention that all sensitive data is securely stored using the Android Keystore and iOS Keychain.
2 participants
Description
Type of Change
Screenshots and Media (if applicable)
Test Scenarios
References
Summary by CodeRabbit