Doc updates and new features #361
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
WalkthroughDocumentation updates applying title capitalization standardization (e.g., "Work items" → "Work Items") across multiple files, with feature expansions including Plane AI branding updates in AI documentation, new filter operators in issue visualization, Initiative state/label capabilities, LaTeX math support, and iOS troubleshooting guidance. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (1 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: 3
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
docs/core-concepts/issues/visualise_filter.mdx (2)
34-34: Operator "in" is undocumented; use "is any of" instead.Lines 34 and 43 use the operator
in, but the reference tables only documentis any offor matching multiple values. Either update the examples to use the documented operator or ensureinis added to the reference tables.Likely fix: Replace
inwithis any of.-Add **Assignee** → **in** → [Select team members] +Add **Assignee** → **is any of** → [Select team members]-Add State → in → [Backlog, To Do] +Add State → **is any of** → [Backlog, To Do]Also applies to: 43-43
42-42: Standardize operator formatting in example.Line 42 uses lowercase
isinconsistently; the rest of the examples use is in bold or backticks for operator names. Apply consistent formatting.-Set **Assignee** → is → [Leave empty] +Set **Assignee** → **is** → [Leave empty]
🧹 Nitpick comments (3)
docs/communication-and-collaboration/comments-and-activity.mdx (1)
1-5: Title capitalization standardized in frontmatter.The frontmatter update aligns with PR-wide capitalization consistency. Note: The H1 heading at line 6 remains lowercase ("Work item comments"), which is acceptable since frontmatter and body headings can differ, but consider updating line 6 to "Work Item Comments" for full visual consistency if desired.
docs/ai/pi-chat.mdx (1)
70-78: Consider adding file size limit.The attachment documentation is clear, but it doesn't mention the file size limit. In
editor-blocks.mdx(line 73), attachments are documented as supporting "up to 100MB each". Consider whether the same limit applies here and should be documented for consistency.docs/core-concepts/projects/initiatives.mdx (1)
163-163: Consider capitalization consistency.The heading uses lowercase "initiatives" while most other references in the document use "Initiatives" (capitalized). This appears inconsistent with section headers like "Create Initiatives" (line 34), "View and manage Initiatives" (line 51), etc.
If title case is preferred for consistency:
-## Sort and filter initiatives +## Sort and filter Initiatives
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (23)
docs/ai/pi-chat.mdx(6 hunks)docs/communication-and-collaboration/comments-and-activity.mdx(1 hunks)docs/communication-and-collaboration/project-updates.mdx(1 hunks)docs/core-concepts/issues/bulk-ops.mdx(1 hunks)docs/core-concepts/issues/estimates.mdx(1 hunks)docs/core-concepts/issues/issue-types.mdx(1 hunks)docs/core-concepts/issues/states.mdx(1 hunks)docs/core-concepts/issues/time-tracking.mdx(1 hunks)docs/core-concepts/issues/visualise_filter.mdx(12 hunks)docs/core-concepts/pages/editor-blocks.mdx(1 hunks)docs/core-concepts/pages/inline-comments.mdx(1 hunks)docs/core-concepts/pages/nested-pages.mdx(1 hunks)docs/core-concepts/projects/initiatives.mdx(4 hunks)docs/core-concepts/projects/project-overview.mdx(1 hunks)docs/core-concepts/projects/project-states.mdx(1 hunks)docs/core-concepts/projects/recurring-work-items.mdx(1 hunks)docs/devices/mobile.mdx(1 hunks)docs/intake/intake-forms.mdx(1 hunks)docs/templates/page-templates.mdx(1 hunks)docs/templates/project-templates.mdx(1 hunks)docs/templates/work-item-templates.mdx(1 hunks)docs/workflows-and-approvals/workflows.mdx(1 hunks)sidebars.ts(2 hunks)
🔇 Additional comments (29)
docs/intake/intake-forms.mdx (1)
2-2: Good title consistency improvement.The plural form "Intake Forms" aligns well with the main heading and the plural context throughout the documentation (e.g., "Collect work items with public web forms").
docs/core-concepts/issues/visualise_filter.mdx (1)
212-283: Verify custom properties filtering is fully implemented and complete.The new "Custom properties" section is comprehensive and well-structured, but it represents significant new feature documentation. Before merge, confirm:
- All 7 property types (Text, Number, Dropdown, Boolean, Date, Member picker, URL) are actually supported in the UI.
- All listed operators for each property type are implemented and functioning correctly.
- The examples match current product behavior.
docs/core-concepts/issues/states.mdx (1)
2-2: Title capitalization applied consistently.The title change from "Workflow states" to "Workflow States" follows proper title case conventions and aligns with the broader branding standardization in this PR.
docs/core-concepts/issues/bulk-ops.mdx (1)
2-2: Title abbreviated differently from other capitalization updates.While the title capitalization change from "Bulk operations" to "Bulk Ops" is clear, note that this introduces an abbreviation rather than pure title case like other files in this PR (which use full capitalized words, e.g., "Workflow States", "Project Overview"). Verify this abbreviation is intentional and consistent with UI labels and product naming conventions.
docs/core-concepts/projects/project-overview.mdx (1)
2-2: Title capitalization applied correctly.The change from "Project overview" to "Project Overview" follows standard title case conventions and is consistent with the capitalization pattern across other documentation files in this PR.
docs/core-concepts/issues/time-tracking.mdx (1)
2-2: Title capitalization applied correctly.The change from "Time tracking" to "Time Tracking" follows standard title case conventions and maintains consistency with the capitalization updates across other documentation files.
docs/templates/project-templates.mdx (1)
2-2: Title capitalization applied correctly.The change from "Project templates" to "Project Templates" applies standard title case consistently with other documentation updates in this PR.
docs/core-concepts/projects/project-states.mdx (1)
2-2: Title capitalization applied correctly.The change from "Project states" to "Project States" follows standard title case conventions consistently with other documentation updates.
docs/core-concepts/pages/nested-pages.mdx (1)
2-2: Title capitalization applied correctly.The change from "Nested pages" to "Nested Pages" applies standard title case consistently with the documentation standardization effort across this PR.
docs/core-concepts/issues/issue-types.mdx (1)
2-2: Title capitalization applied correctly.The change from "Work item types" to "Work Item Types" follows standard title case conventions and is consistent with the capitalization standardization across all documentation files in this PR.
docs/communication-and-collaboration/project-updates.mdx (1)
1-5: Title capitalization aligns with documentation standards.The frontmatter update follows the broader PR pattern of standardizing title capitalization across documentation. No content changes.
docs/core-concepts/projects/recurring-work-items.mdx (1)
1-5: Title capitalization consistent with documentation updates.The frontmatter update follows the PR-wide capitalization standardization. No content or behavior changes.
docs/core-concepts/pages/inline-comments.mdx (1)
1-5: Title update improves clarity and consistency.The frontmatter title change from "Page comments" to "Page Inline Comments" makes the feature more specific and aligns with the PR-wide capitalization standardization. No content changes.
docs/templates/page-templates.mdx (1)
1-5: Title capitalization maintains consistency across template documentation.The frontmatter update aligns with the broader PR capitalization standardization. No content or logic changes.
docs/templates/work-item-templates.mdx (1)
1-5: Title capitalization aligns with template documentation standards.The frontmatter update follows the PR-wide capitalization standardization pattern. No content changes.
docs/devices/mobile.mdx (1)
239-253: iOS troubleshooting section is well-structured and actionable.The new "Link not opening iOS app" section clearly explains the Universal Links behavior on iOS and provides a practical workaround. The step-by-step fix (open in Safari, tap the banner, verify) is user-friendly.
Please verify that the iOS Universal Links behavior described in the troubleshooting section aligns with current Apple documentation. Specifically, confirm:
- That iOS browsers do indeed associate domains with the browser app when the web version is visited first
- That the Safari banner workaround is the recommended approach per Apple's Universal Links documentation
If you'd like, I can search the web for the latest Apple Universal Links documentation to confirm alignment.
docs/workflows-and-approvals/workflows.mdx (1)
1-5: Title change may require navigation/routing updates.The frontmatter title change from "Workflows and approvals" to "Workflows" differs from other cosmetic capitalization updates—this is a semantic change. While the content still covers approval workflows (line 4 mentions "require approval"), the URL/routing metadata may have changed.
Verify that:
- Sidebar navigation or routing configuration has been updated to reflect the new title
- Any internal links to this page still resolve correctly
- This title reduction is intentional (removing "and approvals" removes keyword discoverability)
If sidebar updates are needed, please confirm they've been made in other files (e.g.,
docs/sidebars.tsor routing config) not provided in this review.docs/core-concepts/issues/estimates.mdx (1)
35-37: LGTM! Clear and helpful callout.The info callout appropriately informs users about the Free plan limitation and provides a clear upgrade path. The placement after the enable toggle is logical and non-intrusive.
docs/core-concepts/pages/editor-blocks.mdx (2)
76-85: LGTM! Clear introduction to LaTeX support.The introduction effectively explains the feature and its use cases. The Business plan tag is appropriately displayed.
88-112: LGTM! Comprehensive LaTeX documentation.The documentation clearly explains both block and inline equations with accurate LaTeX examples. The dual syntax approach (slash commands and dollar signs) provides flexibility for different user preferences.
sidebars.ts (1)
131-131: LGTM! Capitalization improvements for consistency.The capitalization changes align these labels with the Title Case pattern used throughout the sidebar navigation, improving overall consistency.
Also applies to: 306-306
docs/ai/pi-chat.mdx (3)
1-17: LGTM! Clean rebrand to Plane AI.The front matter, title, and introduction have been properly updated with the new "Plane AI" branding. The description effectively positions the AI assistant.
79-85: LGTM! Clear voice input documentation.The voice input feature is well-documented with appropriate use cases. The explanation of transcription and processing is clear.
110-236: LGTM! Comprehensive rebrand to Plane AI.The remaining sections have been thoroughly updated with consistent "Plane AI" branding. The documentation covers thread organization, context management, reasoning transparency, tips, privacy, and platform availability in a clear and helpful manner.
docs/core-concepts/projects/initiatives.mdx (5)
45-48: LGTM! Clear documentation of new State and Labels fields.The State and Labels fields are properly documented with clear values, defaults, and prerequisites. The note about setting up labels in workspace settings first is helpful.
98-114: LGTM! Well-defined Initiative states.The five states are clearly documented with distinct descriptions. The workflow progression (Drafts → Planned → Active → Completed/Closed) is logical and the filtering reference is helpful.
115-125: LGTM! Clear label setup and usage instructions.The step-by-step process for creating and assigning labels is well-documented. The note about multiple labels per Initiative adds useful context.
144-151: LGTM! Comprehensive properties list.The properties section has been properly updated to include State and Labels, with clear descriptions that align with the detailed sections earlier in the document.
167-192: LGTM! Comprehensive filtering and display options.The expanded filtering and display documentation thoroughly covers the new State and Labels capabilities. The grouping and ordering options provide flexibility for different workflow needs.
| ### Create items with Plane AI | ||
|
|
||
| Plane AI can create work items, projects, cycles, and modules through natural language commands. | ||
|
|
||
| #### Create a work item | ||
|
|
||
| 1. Ensure you have a project selected using the Focus selector. | ||
| 2. Type a creation command describing what you want to create: | ||
| ``` | ||
| Create a bug report for the login page crash | ||
| ``` | ||
| 3. Plane AI processes your request and shows its thinking. | ||
| 4. Once completed, the work item is created and you'll see a success confirmation with the work item ID. | ||
|
|
||
| The newly created work item will include: | ||
| - Automatically generated title based on your description | ||
| - AI-generated description summarizing the issue | ||
| - Appropriate work item type (bug, feature, etc.) inferred from your command | ||
| - Default project properties | ||
|
|
||
| :::tip | ||
| Be specific in your commands. Include details like priority, assignees, or descriptions to help Plane AI create more complete work items. For example: "Create a high-priority bug for the payment gateway timeout issue and assign it to the backend team." | ||
| ::: |
There was a problem hiding this comment.
Critical inconsistency: read-only claim vs. creation feature.
Lines 86-108 document the ability to create work items, projects, cycles, and modules through Plane AI. However, line 48 states "Plane AI is currently read-only" and lines 48-51 list what it cannot do, including executing actions that modify the workspace. These statements directly contradict the new creation capability documented here.
Either:
- Remove or update the "read-only" statement at line 48 to reflect that Plane AI can now create items, or
- Clarify the distinction between creation capabilities and other write operations
Apply this diff to fix the inconsistency:
-Plane AI is currently **read-only**. It cannot perform actions that modify your workspace:
+Plane AI has limited write capabilities. It can create new items but cannot perform bulk modifications:
-- ❌ Execute automated task workflows.
-- ❌ Handle bulk operations or routine project management tasks.
+- ❌ Modify or delete existing work items.
+- ❌ Execute automated task workflows.
+- ❌ Handle bulk operations or routine project management tasks.Committable suggestion skipped: line range outside the PR's diff.
🤖 Prompt for AI Agents
In docs/ai/pi-chat.mdx around lines 48 and 86-108, there's a contradiction: line
48 claims "Plane AI is currently read-only" while lines 86-108 describe creation
capabilities; update the content to resolve this by either removing or revising
the "read-only" statement to indicate that Plane AI can create items (work
items, projects, cycles, modules) but is limited in other mutating operations,
or add a clarifying sentence near line 48 that explicitly states creation via
natural language is supported while other write actions (e.g., bulk destructive
changes, system-level config edits) remain disallowed; ensure the doc
consistently reflects which write operations are permitted and which are not.
| ## What's coming next | ||
|
|
||
| We're actively working on expanding Pi's capabilities: | ||
| We're actively working on expanding Plane AI's capabilities: | ||
| - **Action execution**: Create and update work items through conversation | ||
| - **Advanced workflows**: Automate routine project management tasks | ||
| - **Voice interface**: Speak your queries instead of typing | ||
| - **Enhanced analytics**: Predictive insights and recommendations | ||
|
|
There was a problem hiding this comment.
Inconsistency: voice interface already documented.
Line 242 lists "Voice interface: Speak your queries instead of typing" under "What's coming next", but lines 79-85 already document the voice input feature as currently available. This creates confusion about whether the feature is live or coming soon.
Apply this diff to remove the duplicate entry:
We're actively working on expanding Plane AI's capabilities:
- **Action execution**: Create and update work items through conversation
- **Advanced workflows**: Automate routine project management tasks
-- **Voice interface**: Speak your queries instead of typing
- **Enhanced analytics**: Predictive insights and recommendations📝 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.
| ## What's coming next | |
| We're actively working on expanding Pi's capabilities: | |
| We're actively working on expanding Plane AI's capabilities: | |
| - **Action execution**: Create and update work items through conversation | |
| - **Advanced workflows**: Automate routine project management tasks | |
| - **Voice interface**: Speak your queries instead of typing | |
| - **Enhanced analytics**: Predictive insights and recommendations | |
| ## What's coming next | |
| We're actively working on expanding Plane AI's capabilities: | |
| - **Action execution**: Create and update work items through conversation | |
| - **Advanced workflows**: Automate routine project management tasks | |
| - **Enhanced analytics**: Predictive insights and recommendations | |
🤖 Prompt for AI Agents
In docs/ai/pi-chat.mdx around lines 237 to 244, remove the "Voice interface:
Speak your queries instead of typing" bullet under "What's coming next" because
voice input is already documented as available earlier (lines 79–85); update the
list to exclude that duplicate entry so the "What's coming next" section only
contains genuinely upcoming features.
|
|
||
| **Paid plans** | ||
| Unlock advanced filtering with additional operators including `is not`, `after`, `before`, and more specialized conditions. We will be adding more conditions here such as `not in`, `contains`, `is empty`, etc. . | ||
| Unlock advanced filtering with additional operators including `is not`, `is not any of`, `after`, `before`, and more specialized conditions. We will be adding more conditions here such as `not in`, `contains`, `is empty`, etc. . |
There was a problem hiding this comment.
Fix grammar error: remove extra space and period.
The text reads "etc. ." with redundant punctuation. Correct to "etc."
-Unlock advanced filtering with additional operators including `is not`, `is not any of`, `after`, `before`, and more specialized conditions. We will be adding more conditions here such as `not in`, `contains`, `is empty`, etc. .
+Unlock advanced filtering with additional operators including `is not`, `is not any of`, `after`, `before`, and more specialized conditions. We will be adding more conditions here such as `not in`, `contains`, `is empty`, etc.📝 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.
| Unlock advanced filtering with additional operators including `is not`, `is not any of`, `after`, `before`, and more specialized conditions. We will be adding more conditions here such as `not in`, `contains`, `is empty`, etc. . | |
| Unlock advanced filtering with additional operators including `is not`, `is not any of`, `after`, `before`, and more specialized conditions. We will be adding more conditions here such as `not in`, `contains`, `is empty`, etc. |
🤖 Prompt for AI Agents
In docs/core-concepts/issues/visualise_filter.mdx around line 80, the phrase
contains redundant punctuation "etc. ."; remove the extra space and period so it
reads "etc." — update the sentence to replace "etc. ." with "etc." ensuring only
a single period follows.
Description
Type of Change
Screenshots and Media (if applicable)
Test Scenarios
References
Summary by CodeRabbit