Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 WalkthroughWalkthroughThese changes reorganize and expand documentation on work item type management. The sidebar configuration restructures "Work Item Types" into a collapsed menu with separate project-level and workspace-level entries. A new workspace-level work item types documentation page is introduced, and existing issue types documentation is updated to reference Task as the default type and note Enterprise Grid workspace-level management. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
📝 Coding Plan
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
🧹 Nitpick comments (2)
docs/core-concepts/workspaces/work-item-types.md (2)
8-8: Remove duplicate sentence.The sentence "This ensures consistency — a 'Bug' in one project has the same properties and structure as a 'Bug' in another" appears identically on both line 8 and line 16. Remove it from one location to avoid redundancy.
📝 Proposed fix (remove from line 16)
## How work item types work -Work item types are workspace-level entities. This means they're defined once by Workspace Admins and can be reused across any project in the workspace. This ensures consistency — a "Bug" in one project has the same properties and structure as a "Bug" in another. +Work item types are workspace-level entities. This means they're defined once by Workspace Admins and can be reused across any project in the workspace.Also applies to: 16-16
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/core-concepts/workspaces/work-item-types.md` at line 8, Remove the duplicate sentence "This ensures consistency — a 'Bug' in one project has the same properties and structure as a 'Bug' in another" so it only appears once in the document; locate the repeated string in the work item types doc (the identical sentence present twice) and delete the redundant instance, leaving the remaining occurrence intact.
148-153: Consider adding reassignment guidance.The delete section warns that "Existing work items of that type will need to be reassigned to another type" but doesn't explain how to do this. Consider adding a brief note or cross-reference on how users can bulk-update work item types (referencing the "Bulk update types" section above) before deletion.
📝 Suggested addition
Deleting a type removes it from the workspace library and from every project that imported it. Existing work items of that type will need to be reassigned to another type. + +To reassign existing work items before deleting a type, use the [bulk update](`#bulk-update-types`) feature to switch them to a different type. Before deleting, consider whether disabling the type would be a better option — it preserves existing work items while preventing new ones from being created.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/core-concepts/workspaces/work-item-types.md` around lines 148 - 153, Update the "Delete a work item type" section to include a brief instruction and cross-reference to the "Bulk update types" section: add a sentence after the warning "Existing work items of that type will need to be reassigned to another type" that tells Workspace Admins they can bulk-update work item types using the "Bulk update types" workflow and link to that section (or include the short steps) so users know how to reassign items before deletion; ensure the text mentions the "Delete a work item type" heading and the "Bulk update types" section to make the cross-reference clear.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/core-concepts/issues/issue-types.md`:
- Line 8: The document inconsistently names the default work item type as `Task`
in the opening and `Issue` elsewhere; decide which is correct and make them
consistent by replacing all occurrences of the incorrect name (e.g., change "The
default type is called `Issue`" and "the work item type `Issue` is selected") to
the chosen canonical name (`Task` or `Issue`) and verify headings, examples, and
captions reference the same term (search for the phrases "default type",
"`Issue`", and "`Task`" and update `Issue`/`Task` instances accordingly).
- Line 108: The table row "| **URL** | A URL field for linking to external
resources. |" is missing the middle "Attributes" column causing markdown table
misalignment; update that row to include a placeholder or appropriate attributes
cell between the pipes (e.g., "| **URL** | [attributes or '—'] | A URL field for
linking to external resources. |") so the row matches the three-column structure
used by other rows and resolves the markdownlint error.
---
Nitpick comments:
In `@docs/core-concepts/workspaces/work-item-types.md`:
- Line 8: Remove the duplicate sentence "This ensures consistency — a 'Bug' in
one project has the same properties and structure as a 'Bug' in another" so it
only appears once in the document; locate the repeated string in the work item
types doc (the identical sentence present twice) and delete the redundant
instance, leaving the remaining occurrence intact.
- Around line 148-153: Update the "Delete a work item type" section to include a
brief instruction and cross-reference to the "Bulk update types" section: add a
sentence after the warning "Existing work items of that type will need to be
reassigned to another type" that tells Workspace Admins they can bulk-update
work item types using the "Bulk update types" workflow and link to that section
(or include the short steps) so users know how to reassign items before
deletion; ensure the text mentions the "Delete a work item type" heading and the
"Bulk update types" section to make the cross-reference clear.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 7c8e86f9-f486-4ba0-bf1d-323c72d0ba22
📒 Files selected for processing (4)
docs/.vitepress/config.tsdocs/core-concepts/issues/issue-types.mddocs/core-concepts/workspaces/work-item-types.mddocs/workspaces-and-users/billing-and-plans.md
| # Add and configure your work item types <Badge type="info" text="Pro" /> | ||
|
|
||
| Work item Types unlock a whole new way of adding, editing, and moving work forward in Plane. The default work item type called `Issue` is great for starting with Plane, but as you advance in your project management journey, you find the need for names and properties unique to the type of work you are doing. | ||
| Work item Types unlock a whole new way of adding, editing, and moving work forward in Plane. The default work item type called `Task` is great for starting with Plane, but as you advance in your project management journey, you find the need for names and properties unique to the type of work you are doing. |
There was a problem hiding this comment.
Inconsistent default type references throughout the document.
Line 8 states the default type is Task, but the document still references Issue as the default in multiple places:
- Line 43: "The default type is called
Issue" - Line 125: "By default, the work item type
Issueis selected"
Either update all references to Task for consistency, or verify which is correct and update accordingly.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/core-concepts/issues/issue-types.md` at line 8, The document
inconsistently names the default work item type as `Task` in the opening and
`Issue` elsewhere; decide which is correct and make them consistent by replacing
all occurrences of the incorrect name (e.g., change "The default type is called
`Issue`" and "the work item type `Issue` is selected") to the chosen canonical
name (`Task` or `Issue`) and verify headings, examples, and captions reference
the same term (search for the phrases "default type", "`Issue`", and "`Task`"
and update `Issue`/`Task` instances accordingly).
| | **Boolean** | True/False | Default value is false. This attribute cannot be marked as mandatory. | | ||
| | **Date** | Date Format | Consistent date format across all properties. | | ||
| | **Member picker** | Single Select, Multi select | Displays a list of all project members. | | ||
| | **URL** | A URL field for linking to external resources. | |
There was a problem hiding this comment.
Fix the table row structure for URL property type.
The URL property row is missing the Attributes column, causing a table formatting error (detected by markdownlint). All other rows have three columns: Property type, Attributes, and Notes.
📝 Proposed fix
-| **URL** | A URL field for linking to external resources. |
+| **URL** | | A URL field for linking to external resources. |📝 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.
| | **URL** | A URL field for linking to external resources. | | |
| | **URL** | | A URL field for linking to external resources. | |
🧰 Tools
🪛 markdownlint-cli2 (0.21.0)
[warning] 108-108: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/core-concepts/issues/issue-types.md` at line 108, The table row "|
**URL** | A URL field for linking to external resources. |" is missing the
middle "Attributes" column causing markdown table misalignment; update that row
to include a placeholder or appropriate attributes cell between the pipes (e.g.,
"| **URL** | [attributes or '—'] | A URL field for linking to external
resources. |") so the row matches the three-column structure used by other rows
and resolves the markdownlint error.
1 participant
Description
Type of Change
Screenshots and Media (if applicable)
Test Scenarios
References
Summary by CodeRabbit
Release Notes