Skip to content

Workspace Work Item Types#417

Open
danciaclara wants to merge 4 commits intomasterfrom
workspace-work-item-types
Open

Workspace Work Item Types#417
danciaclara wants to merge 4 commits intomasterfrom
workspace-work-item-types

Conversation

@danciaclara
Copy link
Copy Markdown
Collaborator

@danciaclara danciaclara commented Mar 20, 2026

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

Release Notes

  • Documentation
    • Reorganized work item types navigation to clarify project-level and workspace-level management options.
    • Added comprehensive guidance for managing work item types at the workspace level in Enterprise Grid.
    • Updated default work item type reference to Task.
    • Introduced URL property type for custom work item properties.

@vercel
Copy link
Copy Markdown

vercel bot commented Mar 20, 2026

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

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Mar 31, 2026 1:16pm

Request Review

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 20, 2026

Warning

Rate limit exceeded

@danciaclara has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 19 minutes and 40 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 19 minutes and 40 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 0cb4d1fe-15fa-4cda-bc3e-fe52e550a7ad

📥 Commits

Reviewing files that changed from the base of the PR and between efd9c9f and 79b3a13.

📒 Files selected for processing (2)
  • docs/core-concepts/issues/issue-types.md
  • docs/core-concepts/workspaces/work-item-types.md
📝 Walkthrough

Walkthrough

These 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

Cohort / File(s) Summary
Navigation Configuration
docs/.vitepress/config.ts
Restructured "Work Item Types" sidebar entry from a direct link to a collapsed parent menu with two child items: "Project-level" and "Workspace-level", enabling separate documentation paths for each scope.
Work Item Type Documentation
docs/core-concepts/issues/issue-types.md, docs/core-concepts/workspaces/work-item-types.md
Updated existing documentation to reference Task as default work item type, added Enterprise Grid workspace-level note with cross-reference. Introduced comprehensive new workspace-level documentation covering enabling, creating, managing custom properties, importing types to projects, and lifecycle administration (disabling/deleting).
Minor Documentation Update
docs/workspaces-and-users/billing-and-plans.md
Removed trailing question mark from section heading "Why per-seat instead of per-user".

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

🐰 Documents reorganized with care,
Work items restructured everywhere,
Project and workspace paths divide,
New documentation deep and wide,
The rabbit's docs now clarified! 📚✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title 'Workspace Work Item Types' directly reflects the main addition—a new documentation page for managing work item types at the workspace level, which is the primary change across the files modified.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch workspace-work-item-types

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 and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

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

📥 Commits

Reviewing files that changed from the base of the PR and between d28b835 and efd9c9f.

📒 Files selected for processing (4)
  • docs/.vitepress/config.ts
  • docs/core-concepts/issues/issue-types.md
  • docs/core-concepts/workspaces/work-item-types.md
  • docs/workspaces-and-users/billing-and-plans.md

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.

1 participant