New sidebar structure #358
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. WalkthroughNormalized many doc titles/headings, added multiple workspace/project/member docs, reorganized the sidebar, updated many internal anchors, swapped most images from Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~30 minutes Poem
Pre-merge checks and finishing touches✅ Passed checks (3 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: 5
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/core-concepts/export.mdx (1)
21-24: Fix the nested list formatting in Step 3.The dash-prefixed items follow the sentence on the same line, so Markdown renders them as plain hyphenated text instead of a bullet list. Insert a blank line before the list (and indent each item) to restore the intended bullets.
🧹 Nitpick comments (8)
docs/core-concepts/workspaces/overview.mdx (4)
6-9: Standardize “workspace” casing for consistency.Use lowercase “workspace” mid‑sentence.
-Think of a Workspace in Plane as your command center, ... +Think of a workspace in Plane as your command center, ... -Picture it like this. A Workspace in Plane is similar to a server in Discord ... +Picture it like this. A workspace in Plane is similar to a server in Discord ...
38-41: Grammar and product limitation check.
- Heading: prefer “Switch workspaces”.
- Please confirm the “same email address” limitation is still accurate.
-## Switch workspace +## Switch workspaces
42-44: Heading casing consistency.Match other headings that use lowercase “workspace”.
-## Delete Workspace +## Delete workspace
3-3: Frontmatter description casing.Align with lowercased “workspaces” elsewhere.
-description: Create and manage Workspaces in Plane. +description: Create and manage workspaces in Plane.docs/introduction/core-concepts.mdx (1)
44-47: Use proper dash instead of “--”.Replace double hyphen with an em dash for readability.
-- Bulk operations are supported--you can add or update multiple work items to cycles at once. +- Bulk operations are supported—you can add or update multiple work items to cycles at once.docs/workspaces-and-users/permissions.mdx (3)
185-189: Unify spelling: favorites vs favourites.Elsewhere you use “favorites”. Pick one globally; suggest American English for consistency.
-<td>Your favourites</td> +<td>Your favorites</td>
512-799: Terminology and casing consistency.Use “Work item(s)” consistently (not “Work Item”). Remove leading spaces in some cell texts (e.g., “ Access Project settings”).
6-2028: Reduce inline HTML and styles for maintainability.Tables are heavily styled with inline HTML and empty className props. Prefer MDX tables or shared CSS classes; this improves readability and future edits.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (21)
docs/core-concepts/deploy.mdx(1 hunks)docs/core-concepts/export.mdx(1 hunks)docs/core-concepts/issues/properties.mdx(1 hunks)docs/core-concepts/issues/states.mdx(1 hunks)docs/core-concepts/power-k.mdx(1 hunks)docs/core-concepts/projects/overview.mdx(1 hunks)docs/core-concepts/workspaces/members.mdx(1 hunks)docs/core-concepts/workspaces/overview.mdx(2 hunks)docs/integrations/github.mdx(2 hunks)docs/introduction/core-concepts.mdx(1 hunks)docs/introduction/home.mdx(3 hunks)docs/introduction/quickstart.mdx(1 hunks)docs/templates/project-templates.mdx(1 hunks)docs/workspaces-and-users/add-remove-seats.mdx(1 hunks)docs/workspaces-and-users/billing-and-plans.mdx(2 hunks)docs/workspaces-and-users/manage-licenses.mdx(1 hunks)docs/workspaces-and-users/manage-subscription.mdx(1 hunks)docs/workspaces-and-users/permissions.mdx(1 hunks)docs/workspaces-and-users/roles.mdx(1 hunks)docs/workspaces-and-users/upgrade-plan.mdx(1 hunks)sidebars.ts(3 hunks)
🔇 Additional comments (5)
sidebars.ts (4)
45-52: Questionable doc ID under “Workspaces”."core-concepts/power-k" looks out of place and may not exist. Please verify placement and existence.
120-127: Potentially misspelled doc ID."core-concepts/issues/visualise_filter" may be “visualize_filter” or a different slug. Please verify.
182-189: Verify doc ID “customers”.Ensure there is a docs/customers.{md,mdx} or an id alias; otherwise this entry will break the build.
3-348: No broken sidebar doc IDs detected. The flagged items (“category”, “doc”, “link”) are config keys, not page IDs.docs/workspaces-and-users/permissions.mdx (1)
1338-1354: ```shell
#!/bin/bashLocate the permissions file
fd permissions.mdx
Once found, search for the 'Guest with view access' row with context
Replace with the actual path returned by fd
rg -nP 'Guest with view access' -C5
</blockquote></details> </blockquote></details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
There was a problem hiding this comment.
Actionable comments posted: 2
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/overview.mdx (1)
10-10: Fix punctuation break in intro sentence.The sentence currently reads “…make progress Think of work items…”, missing punctuation between “progress” and “Think.” Please restore the period (or other separator) so the paragraph parses correctly for readers.
docs/core-concepts/projects/overview.mdx (1)
21-21: Correct the “Project visibilty” typo.“Visibilty” is misspelled—please change it to “visibility” to avoid a user-facing typo and to keep the link anchor accurate.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (28)
docs/automations/custom-automations.mdx(1 hunks)docs/communication-and-collaboration/comments_and-activity.mdx(1 hunks)docs/communication-and-collaboration/project-updates.mdx(1 hunks)docs/core-concepts/account/overview.mdx(1 hunks)docs/core-concepts/account/settings.mdx(1 hunks)docs/core-concepts/analytics.mdx(1 hunks)docs/core-concepts/drafts.mdx(1 hunks)docs/core-concepts/inbox.mdx(1 hunks)docs/core-concepts/issues/display-options.mdx(1 hunks)docs/core-concepts/issues/issue-types.mdx(1 hunks)docs/core-concepts/issues/layouts.mdx(1 hunks)docs/core-concepts/issues/overview.mdx(1 hunks)docs/core-concepts/issues/time-tracking.mdx(1 hunks)docs/core-concepts/issues/timeline-dependency.mdx(1 hunks)docs/core-concepts/pages/overview.mdx(1 hunks)docs/core-concepts/projects/manage-project-members.mdx(1 hunks)docs/core-concepts/projects/overview.mdx(1 hunks)docs/core-concepts/projects/project-overview.mdx(1 hunks)docs/core-concepts/projects/project-states.mdx(1 hunks)docs/core-concepts/views.mdx(1 hunks)docs/core-concepts/workspaces/overview.mdx(2 hunks)docs/dashboards.mdx(1 hunks)docs/templates/page-templates.mdx(1 hunks)docs/templates/work-item-templates.mdx(1 hunks)docs/workflows-and-approvals/workflows.mdx(1 hunks)docs/your-work.mdx(1 hunks)sidebars.ts(3 hunks)src/css/custom.css(1 hunks)
✅ Files skipped from review due to trivial changes (14)
- docs/core-concepts/issues/timeline-dependency.mdx
- docs/automations/custom-automations.mdx
- docs/core-concepts/drafts.mdx
- docs/templates/page-templates.mdx
- docs/core-concepts/issues/time-tracking.mdx
- docs/core-concepts/pages/overview.mdx
- docs/core-concepts/issues/issue-types.mdx
- docs/core-concepts/issues/display-options.mdx
- docs/workflows-and-approvals/workflows.mdx
- docs/core-concepts/account/settings.mdx
- docs/core-concepts/account/overview.mdx
- docs/communication-and-collaboration/project-updates.mdx
- docs/core-concepts/views.mdx
- docs/communication-and-collaboration/comments_and-activity.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/core-concepts/workspaces/overview.mdx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Cursor Bugbot
🔇 Additional comments (4)
docs/templates/work-item-templates.mdx (1)
2-2: Title normalization looks good.Lowercase styling matches the capitalization refresh elsewhere.
sidebars.ts (3)
255-270: Custom integration documentation links are valid
All links in the Custom Integrations section return HTTP 200 status.
68-88: Authentication documentation links are valid. All four external links return HTTP 200.
327-368: All external support and resource links are valid
All URLs respond with HTTP 200 or valid redirects (307).
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
docs/core-concepts/workspaces/members.mdx (1)
8-24: Reinstate role-permissions guidanceLine 18 still tells readers to pick Admin/Member/Guest without giving the promised “what they can do” detail or a hand-off to the new permissions breakdown. Please add a short permissions summary or, at minimum, link directly to the dedicated roles/permissions doc so the guidance isn’t lost.
Apply this diff to keep the streamlined flow while restoring the missing hand-off:
- - Select their role: **Admin**, **Member**, or **Guest**. + - Select their role: **Admin**, **Member**, or **Guest**. See [Workspace roles and permissions](/workspaces-and-users/roles) for what each role can do.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (8)
docs/core-concepts/account/overview.mdx(3 hunks)docs/core-concepts/projects/manage-project-members.mdx(1 hunks)docs/core-concepts/workspaces/members.mdx(1 hunks)docs/core-concepts/workspaces/overview.mdx(1 hunks)docs/workspaces-and-users/permissions.mdx(1 hunks)docs/workspaces-and-users/roles.mdx(1 hunks)docs/workspaces-and-users/search-workspace.mdx(1 hunks)sidebars.ts(3 hunks)
✅ Files skipped from review due to trivial changes (3)
- docs/workspaces-and-users/search-workspace.mdx
- docs/workspaces-and-users/roles.mdx
- docs/workspaces-and-users/permissions.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/core-concepts/projects/manage-project-members.mdx
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docs/core-concepts/account/settings.mdx (1)
75-83: Consider formatting the language list for better readability.The language list on line 82 contains 19 languages in a single line, which may be difficult to scan. Consider formatting as a bulleted list for improved readability.
Apply this diff to format the languages as a list:
-**Language:** -- Controls interface language. -- Supported languages: English, French, Spanish, Japanese, Simplified Chinese, Traditional Chinese, Russian, Italian, Czech, Slovak, German, Ukrainian, Polish, Korean, Brazilian Portuguese, Indonesian, Romanian, Vietnamese, Turkish +**Language:** +Controls interface language. + +Supported languages: +- English +- French, Spanish, German, Italian, Romanian +- Japanese, Simplified Chinese, Traditional Chinese, Korean +- Russian, Ukrainian, Polish, Czech, Slovak +- Brazilian Portuguese +- Indonesian, Vietnamese, Turkishdocs/core-concepts/workspaces/members.mdx (1)
6-11: Ensure cross-reference to role permissions documentation.The page focuses on member management actions, which is appropriate. However, users may also need to understand role permissions when inviting or changing member roles.
Consider adding a brief cross-reference to the permissions documentation. Apply this diff:
This guide shows you how to add members to your workspace, change their roles, and remove them when needed. + +For details on what each role can do, see [Roles](/workspaces-and-users/roles) and [Permissions](/workspaces-and-users/permissions).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
docs/core-concepts/account/settings.mdx(1 hunks)docs/core-concepts/workspaces/members.mdx(1 hunks)docs/workspaces-and-users/add-remove-seats.mdx(1 hunks)docs/workspaces-and-users/manage-licenses.mdx(1 hunks)docs/workspaces-and-users/upgrade-plan.mdx(1 hunks)sidebars.ts(3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/workspaces-and-users/add-remove-seats.mdx
🔇 Additional comments (14)
docs/workspaces-and-users/manage-licenses.mdx (3)
1-9: LGTM!The front matter and warning section are well-structured. The warning appropriately directs Community edition users to the upgrade documentation before attempting license activation.
11-28: LGTM!The license activation workflow is clear, well-structured, and provides appropriate visual guidance. The step-by-step instructions are easy to follow.
30-44: Confirm CLI command syntaxEnsure that
prime-cli restartis the correct subcommand to restart the instance (e.g., verify viaprime-cli --helpor the CLI reference).docs/workspaces-and-users/upgrade-plan.mdx (1)
1-18: LGTM!The simplified upgrade flow appropriately focuses on the cloud upgrade process while cross-referencing the dedicated license management page for self-hosted users. This separation of concerns improves documentation maintainability.
docs/core-concepts/account/settings.mdx (5)
1-14: LGTM!The updated title and expanded description accurately reflect the comprehensive nature of account settings. The access instructions are clear and well-illustrated.
16-33: LGTM!The Profile section is well-organized with clear subsections for visual elements, personal information, and account deactivation. The content is comprehensive and user-friendly.
85-111: LGTM!The Notifications section clearly defines the scope and provides comprehensive details on each notification type. The cross-reference to the Inbox is helpful for users.
113-122: LGTM!The Security section appropriately documents password change requirements and fields. The security criteria note is a good addition.
124-136: LGTM!The Activity, Connections, and Personal access tokens sections provide clear, concise descriptions of their respective functionality. The content is appropriate for an overview page.
docs/core-concepts/workspaces/members.mdx (2)
12-31: LGTM!The invitation workflow is clear, comprehensive, and includes helpful details about pending invitations and SMTP configuration for self-hosted instances.
33-58: LGTM!The role change and member removal workflows are clear and actionable. The billing warning with cross-reference to seat management is particularly valuable for preventing confusion about billing impacts.
sidebars.ts (3)
4-102: LGTM!The new "Workspace management" category structure is well-organized with logical subcategories for Workspaces, Members, Authentication, and Billing. The external links to self-hosting documentation are appropriately separated from the main docs.
103-194: LGTM!The progression from Project management → Work item management → Planning and organization → Views and layouts → Collaboration → Advanced management follows a natural user workflow. The categorization is logical and user-friendly.
195-370: LGTM! Verify external links if possible.The remaining categories are well-structured, particularly the split between Native and Custom integrations, and the consolidated Support and resources section. The extensive use of external links is appropriate for resources, developer documentation, and community links.
Consider periodically verifying that the external links remain valid, especially for:
- Developer documentation (developers.plane.so)
- Marketplace and templates (plane.so/marketplace, plane.so/templates)
- Status page (status.plane.so)
- Community links (Discord, GitHub)
This can be automated with a link checker in your CI/CD pipeline.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
There was a problem hiding this comment.
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/core-concepts/issues/overview.mdx (1)
10-10: Fix grammar and punctuation.Missing period and number agreement.
Apply this diff:
-In Plane, a work item serves as the fundamental unit of work. They represent the tasks you need to accomplish to make progress Think of work items as the to-dos of your project management flow—assignable, trackable, and actionable. +In Plane, work items are the fundamental unit of work. They represent the tasks you need to accomplish to make progress. Think of work items as the to-dos of your project management flow—assignable, trackable, and actionable.
♻️ Duplicate comments (1)
docs/core-concepts/views.mdx (1)
6-10: Fix MDX import order: move imports above contentImports must precede any markdown content in MDX. Move the import above the heading to avoid parsing/render issues.
Apply:
-# Save custom views - -import Tags from "@site/src/components/Tags"; +import Tags from "@site/src/components/Tags"; + +# Save custom views
🧹 Nitpick comments (2)
docs/core-concepts/projects/recurring-work-items.mdx (1)
26-26: Anchor verified; no broken links.
- /core-concepts/projects/overview#configure-project-settings exists.
- No legacy /#project-settings references detected; alias/back-compat not required.
- Optional: standardize “Project Settings” capitalization across docs.
docs/core-concepts/issues/overview.mdx (1)
2-2: Title looks good; consider aligning H1/SEO/sidebar label.Frontmatter title is “Manage work items” while the H1 is “Create, organize, and track project tasks.” Consider aligning for consistency in breadcrumbs/SEO/sidebar.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (20)
docs/communication-and-collaboration/comments_and-activity.mdx(1 hunks)docs/communication-and-collaboration/project-updates.mdx(1 hunks)docs/core-concepts/analytics.mdx(1 hunks)docs/core-concepts/cycles.mdx(1 hunks)docs/core-concepts/drafts.mdx(1 hunks)docs/core-concepts/issues/epics.mdx(1 hunks)docs/core-concepts/issues/overview.mdx(3 hunks)docs/core-concepts/issues/states.mdx(1 hunks)docs/core-concepts/modules.mdx(1 hunks)docs/core-concepts/pages/inline-comments.mdx(1 hunks)docs/core-concepts/projects/manage-project-members.mdx(1 hunks)docs/core-concepts/projects/overview.mdx(1 hunks)docs/core-concepts/projects/project-overview.mdx(2 hunks)docs/core-concepts/projects/recurring-work-items.mdx(1 hunks)docs/core-concepts/views.mdx(2 hunks)docs/templates/page-templates.mdx(2 hunks)docs/templates/project-templates.mdx(2 hunks)docs/templates/work-item-templates.mdx(3 hunks)docs/workflows-and-approvals/workflows.mdx(2 hunks)sidebars.ts(3 hunks)
✅ Files skipped from review due to trivial changes (3)
- docs/core-concepts/pages/inline-comments.mdx
- docs/core-concepts/issues/epics.mdx
- docs/communication-and-collaboration/comments_and-activity.mdx
🚧 Files skipped from review as they are similar to previous changes (9)
- docs/core-concepts/projects/manage-project-members.mdx
- docs/templates/project-templates.mdx
- docs/core-concepts/projects/project-overview.mdx
- docs/workflows-and-approvals/workflows.mdx
- docs/core-concepts/issues/states.mdx
- docs/templates/page-templates.mdx
- docs/core-concepts/drafts.mdx
- docs/communication-and-collaboration/project-updates.mdx
- docs/templates/work-item-templates.mdx
🔇 Additional comments (12)
docs/core-concepts/modules.mdx (1)
12-12: LGTM: anchor standardized to configure-project-settingsConsistent with the updated Projects overview section and other docs.
docs/core-concepts/views.mdx (1)
21-21: Anchor updated to configure-project-settings — goodMatches the Projects overview heading.
docs/core-concepts/projects/overview.mdx (1)
86-96: Good: “Configure project settings” section establishes the expected anchorThis provides the #configure-project-settings target referenced by other pages (Cycles, Modules, Views).
docs/core-concepts/cycles.mdx (1)
26-28: Anchor update verified: Found## Configure project settingsat line 86 in docs/core-concepts/projects/overview.mdx.docs/core-concepts/issues/overview.mdx (2)
142-144: Heading case is consistent; verify plan tier tag.“Convert work items to epics” is now sentence case—good. Please confirm this feature is correctly gated to the “Business” tier.
155-156: Verified link target; no redirects needed. The document exists at /communication-and-collaboration/comments_and-activity (underscores match the filename), and no inbound links to the removed #view-work-item-activity anchor were found.docs/core-concepts/analytics.mdx (1)
8-8: LGTM! More descriptive heading.The heading change from "Analytics" to "View analytics at different levels" provides better context for readers about the content structure and improves scannability.
sidebars.ts (5)
28-32: LGTM! Useful addition.Adding a direct "Download Plane" link improves user access to the application.
254-268: Custom integration documentation links are valid. All checked URLs return HTTP 200.
64-88: All external authentication documentation links are accessible. All four links returned HTTP 200 OK.
318-369: External resource links verified All URLs in the Support and resources section returned HTTP 200.
1-374: All internal documentation paths verified
All referenced MDX/MD files exist under docs/.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (4)
docs/core-concepts/issues/epics.mdx (1)
94-97: Restore semantic heading structure for gated section.Putting the Markdown heading inside
<div className="tag-wrapper">stops MDX from turning it into an actual<h2>, so “Duplicate Epics” disappears from the document heading hierarchy and the table of contents/backlink anchors break. Convert the copy to a real heading element (same applies to the Business-gated block lower in the file).-<div className="tag-wrapper"> - ## Duplicate Epics - <Tags tags={[{ name: "Pro", link: "https://plane.so/pricing", additionalClass: "pro" }]} /> -</div> +<div className="tag-wrapper"> + <h2>Duplicate Epics</h2> + <Tags tags={[{ name: "Pro", link: "https://plane.so/pricing", additionalClass: "pro" }]} /> +</div>…and mirror that change for the “Convert Epics to Work Items” wrapper.
docs/integrations/sentry.mdx (1)
29-36: Fix duplicated image fragment identifiers
Several image URLs now end with#hero#hero. The extra#heromeans the MDX transformer no longer recognizes the intended#herofragment, so the hero styling class won’t apply. Please trim the duplicates (keep a single#hero) for each affected image.- + - +Also applies to: 50-53
docs/templates/work-item-templates.mdx (1)
45-54: Clean up phrasing in Step 4
Line 50 currently reads “choose and from available templates,” which is grammatically incorrect. Please drop the stray “and” so the instruction reads smoothly (“choose from available templates”).-4. Click the templates icon and choose and from available templates in the dropdown menu. +4. Click the templates icon and choose from available templates in the dropdown menu.docs/automations/custom-automations.mdx (1)
70-72: Fix the Step 8 wordingLine 71 reads “to to start turn on,” which is a copy-edit slip. Tighten the sentence so it’s readable.
-8. Click **Enable** on the top right corner of the screen to to start turn on the automation on your project. +8. Click **Enable** in the top-right corner to turn on the automation for your project.
♻️ Duplicate comments (2)
docs/core-concepts/workspaces/members.mdx (1)
8-28: Restore the promised permissions guidanceLine 8 introduces role-based access but the page never points readers to the actual permissions breakdown. Add a sentence linking to the dedicated roles/permissions doc so admins can find the detailed capabilities for Admin, Member, and Guest roles. Without it, the flow drops essential context.
This guide shows you how to add members to your workspace, change their roles, and remove them when needed. + +For a full breakdown of what Admins, Members, and Guests can do, see [Workspace roles and permissions](/workspaces-and-users/roles).docs/core-concepts/workspaces/overview.mdx (1)
14-18: Fix the looping “Explore roles” linkLine 17 still loops back to this doc set instead of the actual roles/permissions page. Point the link to the canonical roles doc so readers reach the promised content.
- Invite your teammates, collaborators, or managers to join your workspace. Each user gets a role, like Admin, Member, or Guest, to control what they can do. [Explore roles here](/core-concepts/workspaces/members). + Invite your teammates, collaborators, or managers to join your workspace. Each user gets a role, like Admin, Member, or Guest, to control what they can do. [Explore roles here](/workspaces-and-users/roles).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (77)
docs/ai/pi-chat.mdx(2 hunks)docs/automations/custom-automations.mdx(4 hunks)docs/communication-and-collaboration/comments_and-activity.mdx(1 hunks)docs/communication-and-collaboration/project-updates.mdx(1 hunks)docs/core-concepts/account/overview.mdx(2 hunks)docs/core-concepts/account/settings.mdx(1 hunks)docs/core-concepts/analytics.mdx(6 hunks)docs/core-concepts/cycles.mdx(7 hunks)docs/core-concepts/drafts.mdx(1 hunks)docs/core-concepts/export.mdx(3 hunks)docs/core-concepts/inbox.mdx(4 hunks)docs/core-concepts/intake.mdx(6 hunks)docs/core-concepts/issues/bulk-ops.mdx(1 hunks)docs/core-concepts/issues/display-options.mdx(1 hunks)docs/core-concepts/issues/epics.mdx(9 hunks)docs/core-concepts/issues/estimates.mdx(3 hunks)docs/core-concepts/issues/issue-types.mdx(7 hunks)docs/core-concepts/issues/labels.mdx(2 hunks)docs/core-concepts/issues/overview.mdx(10 hunks)docs/core-concepts/issues/states.mdx(2 hunks)docs/core-concepts/issues/time-tracking.mdx(3 hunks)docs/core-concepts/issues/timeline-dependency.mdx(3 hunks)docs/core-concepts/issues/visualise_filter.mdx(1 hunks)docs/core-concepts/modules.mdx(6 hunks)docs/core-concepts/pages/editor-blocks.mdx(2 hunks)docs/core-concepts/pages/inline-comments.mdx(3 hunks)docs/core-concepts/pages/nested-pages.mdx(1 hunks)docs/core-concepts/pages/overview.mdx(7 hunks)docs/core-concepts/pages/wiki.mdx(2 hunks)docs/core-concepts/power-k.mdx(3 hunks)docs/core-concepts/projects/initiatives.mdx(5 hunks)docs/core-concepts/projects/manage-project-members.mdx(1 hunks)docs/core-concepts/projects/overview.mdx(1 hunks)docs/core-concepts/projects/project-overview.mdx(5 hunks)docs/core-concepts/projects/project-states.mdx(4 hunks)docs/core-concepts/projects/recurring-work-items.mdx(1 hunks)docs/core-concepts/projects/run-project.mdx(3 hunks)docs/core-concepts/stickies.mdx(1 hunks)docs/core-concepts/views.mdx(4 hunks)docs/core-concepts/workspaces/members.mdx(1 hunks)docs/core-concepts/workspaces/overview.mdx(1 hunks)docs/core-concepts/workspaces/teamspaces.mdx(8 hunks)docs/customers.mdx(5 hunks)docs/dashboards.mdx(6 hunks)docs/importers/asana.mdx(2 hunks)docs/importers/clickup.mdx(2 hunks)docs/importers/confluence.mdx(1 hunks)docs/importers/jira.mdx(3 hunks)docs/importers/linear.mdx(2 hunks)docs/importers/notion.mdx(2 hunks)docs/intake/intake-email.mdx(1 hunks)docs/intake/intake-forms.mdx(2 hunks)docs/integrations/github.mdx(10 hunks)docs/integrations/gitlab.mdx(3 hunks)docs/integrations/sentry.mdx(4 hunks)docs/integrations/slack.mdx(9 hunks)docs/introduction/home.mdx(3 hunks)docs/introduction/quickstart.mdx(6 hunks)docs/introduction/tutorials/collaborate-on-work-items.mdx(4 hunks)docs/introduction/tutorials/create-pages.mdx(4 hunks)docs/introduction/tutorials/create-project.mdx(6 hunks)docs/introduction/tutorials/create-work-items.mdx(3 hunks)docs/introduction/tutorials/create-workspace.mdx(4 hunks)docs/introduction/tutorials/invite-members.mdx(3 hunks)docs/introduction/tutorials/organize-and-view-work.mdx(4 hunks)docs/introduction/tutorials/plan-and-create-cycles.mdx(4 hunks)docs/templates/page-templates.mdx(4 hunks)docs/templates/project-templates.mdx(3 hunks)docs/templates/work-item-templates.mdx(4 hunks)docs/workflows-and-approvals/workflows.mdx(3 hunks)docs/workspaces-and-users/add-remove-seats.mdx(1 hunks)docs/workspaces-and-users/billing-and-plans.mdx(2 hunks)docs/workspaces-and-users/manage-licenses.mdx(1 hunks)docs/workspaces-and-users/search-workspace.mdx(1 hunks)docs/workspaces-and-users/upgrade-plan.mdx(1 hunks)docs/your-work.mdx(1 hunks)src/css/custom.css(3 hunks)
✅ Files skipped from review due to trivial changes (16)
- docs/core-concepts/pages/nested-pages.mdx
- docs/introduction/tutorials/organize-and-view-work.mdx
- docs/introduction/tutorials/create-work-items.mdx
- docs/intake/intake-email.mdx
- docs/importers/linear.mdx
- docs/introduction/tutorials/plan-and-create-cycles.mdx
- docs/introduction/tutorials/invite-members.mdx
- docs/core-concepts/issues/visualise_filter.mdx
- docs/core-concepts/issues/labels.mdx
- docs/core-concepts/projects/run-project.mdx
- docs/introduction/tutorials/create-project.mdx
- docs/core-concepts/intake.mdx
- docs/introduction/tutorials/collaborate-on-work-items.mdx
- docs/importers/confluence.mdx
- docs/core-concepts/issues/bulk-ops.mdx
- docs/communication-and-collaboration/project-updates.mdx
🚧 Files skipped from review as they are similar to previous changes (19)
- docs/core-concepts/projects/manage-project-members.mdx
- docs/customers.mdx
- docs/core-concepts/issues/issue-types.mdx
- docs/your-work.mdx
- docs/integrations/slack.mdx
- docs/core-concepts/issues/time-tracking.mdx
- docs/workspaces-and-users/search-workspace.mdx
- docs/workspaces-and-users/add-remove-seats.mdx
- docs/workspaces-and-users/billing-and-plans.mdx
- docs/core-concepts/projects/initiatives.mdx
- docs/core-concepts/pages/inline-comments.mdx
- docs/core-concepts/views.mdx
- docs/core-concepts/cycles.mdx
- docs/dashboards.mdx
- docs/core-concepts/modules.mdx
- docs/core-concepts/projects/recurring-work-items.mdx
- docs/core-concepts/projects/project-states.mdx
- docs/templates/page-templates.mdx
- docs/core-concepts/export.mdx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Cursor Bugbot
🔇 Additional comments (2)
docs/core-concepts/projects/project-overview.mdx (1)
22-71: Nice consistency pass across overview visuals.Hero anchors plus the new “See also” pointer make the page flow cleaner and align with the reorganized sidebar.
docs/core-concepts/analytics.mdx (1)
8-8: Confirm removal of#analyticsanchor is safe
A repo-wide search found no references tocore-concepts/analytics#analytics. Verify any external or published deep-links before removing the original heading or anchor; if needed, add a manual<a id="analytics"/>above the H1.
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
docs/communication-and-collaboration/comments-and-activity.mdx(1 hunks)docs/core-concepts/issues/overview.mdx(10 hunks)docs/core-concepts/workspaces/overview.mdx(1 hunks)docs/workspaces-and-users/upgrade-plan.mdx(1 hunks)sidebars.ts(3 hunks)src/css/custom.css(3 hunks)
✅ Files skipped from review due to trivial changes (1)
- docs/communication-and-collaboration/comments-and-activity.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/core-concepts/issues/overview.mdx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Cursor Bugbot
🔇 Additional comments (7)
docs/core-concepts/workspaces/overview.mdx (1)
16-17: Link fix confirmed“Explore roles here” now routes to
/workspaces-and-users/roles, clearing the loop back to the members page. 👍sidebars.ts (6)
304-308: No action required: MCP server documentation link is accessible (HTTP 200).
1-374: All internal documentation file references exist
No missing files found indocs/(86/86).
250-270: Custom integration links are accessible
All three external documentation URLs return HTTP 200; no changes needed.
64-89: Authentication documentation links are valid All four external OAuth/SSO URLs return HTTP 200.
202-212: File naming consistency verified The file docs/communication-and-collaboration/comments-and-activity.mdx uses hyphens and matches the sidebar entry; no rename needed.
317-370: All external support and resource links resolve successfully – all URLs return HTTP 200 after following redirects.
| title: Upgrade plan | ||
| description: Upgrade to paid plans in Plane, activate license keys on self-hosted instances, manage seats, and handle subscription changes. |
There was a problem hiding this comment.
Update front matter description to match the page scope.
The body now focuses exclusively on the upgrade flow, but the description still promises seat management and subscription-change guidance. Please trim the description so the metadata reflects the content.
🤖 Prompt for AI Agents
In docs/workspaces-and-users/upgrade-plan.mdx around lines 2 to 3, the
front-matter description overpromises features (seat management and subscription
changes) not covered on this page; update the description to briefly reflect the
page's actual scope (the upgrade flow, activating paid plans/license keys) by
trimming or replacing the description so metadata accurately matches content.
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
src/css/custom.css(3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Cursor Bugbot
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
src/css/custom.css (1)
800-928: Add non-:has() fallback, dark-mode colors, and responsive paddings for hero blocks.
- Older browsers without
:has()won’t get the container background/padding; provide a baseline fallback onimgand gate enhancements with@supports(selector(:has(*))).- Add dark theme overrides for background/border.
- Replace fixed paddings with
clamp()for small screens.Apply this diff to the hero section:
-.markdown p:has(> img[src$="#hero"]), -article p:has(> img[src$="#hero"]) { - max-width: 841px; - padding: 36px 56px 0px 56px; - background: #F1F3F3; - border-radius: 12px; - box-sizing: border-box; - overflow: hidden; -} - -.markdown img[src$="#hero"], -article img[src$="#hero"] { - width: 100%; - height: auto; - display: block; - margin: 0; - border-radius: 8px 8px 0px 0px; - border-width: 1px 1px 0px 1px; - border-style: solid; - border-color: #EAEBEB; - object-fit: cover; - box-shadow: - 0px 2px 4px -1px rgba(41, 47, 61, 0.04), - 0px 4px 6px -1px rgba(41, 47, 61, 0.05); -} +/* Fallback for browsers without :has(): style the image itself like a card */ +.markdown img[src$="#hero"], +article img[src$="#hero"] { + width: 100%; + height: auto; + display: block; + margin: 0; + box-sizing: border-box; + padding: clamp(12px, 4vw, 36px) clamp(16px, 6vw, 56px) 0 clamp(16px, 6vw, 56px); + background: #F1F3F3; + border-radius: 12px; + border: 1px solid #EAEBEB; + object-fit: cover; + box-shadow: + 0px 2px 4px -1px rgba(41, 47, 61, 0.04), + 0px 4px 6px -1px rgba(41, 47, 61, 0.05); +} +[data-theme="dark"] .markdown img[src$="#hero"], +[data-theme="dark"] article img[src$="#hero"] { + background: #202B3D; + border-color: #2E3A4F; +} + +/* Use advanced parent styling when :has() is supported */ +@supports (selector(:has(*))) { + .markdown p:has(> img[src$="#hero"]), + article p:has(> img[src$="#hero"]) { + max-width: 841px; + padding: clamp(12px, 4vw, 36px) clamp(16px, 6vw, 56px) 0 clamp(16px, 6vw, 56px); + background: #F1F3F3; + border-radius: 12px; + box-sizing: border-box; + overflow: hidden; + } + [data-theme="dark"] .markdown p:has(> img[src$="#hero"]), + [data-theme="dark"] article p:has(> img[src$="#hero"]) { + background: #202B3D; + } + .markdown img[src$="#hero"], + article img[src$="#hero"] { + /* remove fallback padding/background when parent is styled */ + padding: 0; + background: transparent; + border-radius: 8px 8px 0 0; + border-width: 1px 1px 0 1px; + border-style: solid; + border-color: #EAEBEB; + } + [data-theme="dark"] .markdown img[src$="#hero"], + [data-theme="dark"] article img[src$="#hero"] { + border-color: #2E3A4F; + } +} @@ -.markdown p:has(> img[src$="#hero-tl"]), -article p:has(> img[src$="#hero-tl"]) { - max-width: 841px; - padding: 36px 0px 0px 56px; - background: #F1F3F3; - border-radius: 12px; - box-sizing: border-box; - overflow: hidden; -} +/* Fallback */ +.markdown img[src$="#hero-tl"], +article img[src$="#hero-tl"] { + width: 100%; height: auto; display: block; margin: 0; + box-sizing: border-box; + padding: clamp(12px, 4vw, 36px) 0 0 clamp(16px, 6vw, 56px); + background: #F1F3F3; + border-radius: 12px; + border: 1px solid #EAEBEB; + object-fit: cover; + box-shadow: 0px 2px 4px -1px rgba(41,47,61,0.04), 0px 4px 6px -1px rgba(41,47,61,0.05); +} +[data-theme="dark"] .markdown img[src$="#hero-tl"], +[data-theme="dark"] article img[src$="#hero-tl"] { background: #202B3D; border-color: #2E3A4F; } +@supports (selector(:has(*))) { + .markdown p:has(> img[src$="#hero-tl"]), + article p:has(> img[src$="#hero-tl"]) { + max-width: 841px; + padding: clamp(12px, 4vw, 36px) 0 0 clamp(16px, 6vw, 56px); + background: #F1F3F3; + border-radius: 12px; + box-sizing: border-box; + overflow: hidden; + } + [data-theme="dark"] .markdown p:has(> img[src$="#hero-tl"]), + [data-theme="dark"] article p:has(> img[src$="#hero-tl"]) { background: #202B3D; } + .markdown img[src$="#hero-tl"], + article img[src$="#hero-tl"] { + padding: 0; background: transparent; + border-radius: 8px 0 0 0; border-width: 1px 0 0 1px; border-style: solid; border-color: #EAEBEB; + } + [data-theme="dark"] .markdown img[src$="#hero-tl"], + [data-theme="dark"] article img[src$="#hero-tl"] { border-color: #2E3A4F; } +} @@ -.markdown p:has(> img[src$="#hero-tr"]), -article p:has(> img[src$="#hero-tr"]) { - max-width: 841px; - padding: 36px 56px 0px 0px; - background: #F1F3F3; - border-radius: 12px; - box-sizing: border-box; - overflow: hidden; -} +/* Fallback */ +.markdown img[src$="#hero-tr"], +article img[src$="#hero-tr"] { + width: 100%; height: auto; display: block; margin: 0; + box-sizing: border-box; + padding: clamp(12px, 4vw, 36px) clamp(16px, 6vw, 56px) 0 0; + background: #F1F3F3; + border-radius: 12px; + border: 1px solid #EAEBEB; + object-fit: cover; + box-shadow: 0px 2px 4px -1px rgba(41,47,61,0.04), 0px 4px 6px -1px rgba(41,47,61,0.05); +} +[data-theme="dark"] .markdown img[src$="#hero-tr"], +[data-theme="dark"] article img[src$="#hero-tr"] { background: #202B3D; border-color: #2E3A4F; } +@supports (selector(:has(*))) { + .markdown p:has(> img[src$="#hero-tr"]), + article p:has(> img[src$="#hero-tr"]) { + max-width: 841px; + padding: clamp(12px, 4vw, 36px) clamp(16px, 6vw, 56px) 0 0; + background: #F1F3F3; border-radius: 12px; box-sizing: border-box; overflow: hidden; + } + [data-theme="dark"] .markdown p:has(> img[src$="#hero-tr"]), + [data-theme="dark"] article p:has(> img[src$="#hero-tr"]) { background: #202B3D; } + .markdown img[src$="#hero-tr"], + article img[src$="#hero-tr"] { + padding: 0; background: transparent; + border-radius: 0 8px 0 0; border-width: 1px 1px 0 0; border-style: solid; border-color: #EAEBEB; + } + [data-theme="dark"] .markdown img[src$="#hero-tr"], + [data-theme="dark"] article img[src$="#hero-tr"] { border-color: #2E3A4F; } +} @@ -.markdown p:has(> img[src$="#hero-bl"]), -article p:has(> img[src$="#hero-bl"]) { - max-width: 841px; - padding: 0px 0px 36px 56px; - background: #F1F3F3; - border-radius: 12px; - box-sizing: border-box; - overflow: hidden; -} +/* Fallback */ +.markdown img[src$="#hero-bl"], +article img[src$="#hero-bl"] { + width: 100%; height: auto; display: block; margin: 0; + box-sizing: border-box; + padding: 0 0 clamp(12px, 4vw, 36px) clamp(16px, 6vw, 56px); + background: #F1F3F3; + border-radius: 12px; + border: 1px solid #EAEBEB; + object-fit: cover; + box-shadow: 0px 2px 4px -1px rgba(41,47,61,0.04), 0px 4px 6px -1px rgba(41,47,61,0.05); +} +[data-theme="dark"] .markdown img[src$="#hero-bl"], +[data-theme="dark"] article img[src$="#hero-bl"] { background: #202B3D; border-color: #2E3A4F; } +@supports (selector(:has(*))) { + .markdown p:has(> img[src$="#hero-bl"]), + article p:has(> img[src$="#hero-bl"]) { + max-width: 841px; + padding: 0 0 clamp(12px, 4vw, 36px) clamp(16px, 6vw, 56px); + background: #F1F3F3; border-radius: 12px; box-sizing: border-box; overflow: hidden; + } + [data-theme="dark"] .markdown p:has(> img[src$="#hero-bl"]), + [data-theme="dark"] article p:has(> img[src$="#hero-bl"]) { background: #202B3D; } + .markdown img[src$="#hero-bl"], + article img[src$="#hero-bl"] { + padding: 0; background: transparent; + border-radius: 0 0 0 8px; border-width: 0 0 1px 1px; border-style: solid; border-color: #EAEBEB; + } + [data-theme="dark"] .markdown img[src$="#hero-bl"], + [data-theme="dark"] article img[src$="#hero-bl"] { border-color: #2E3A4F; } +} @@ -.markdown p:has(> img[src$="#hero-br"]), -article p:has(> img[src$="#hero-br"]) { - max-width: 841px; - padding: 0px 56px 36px 0px; - background: #F1F3F3; - border-radius: 12px; - box-sizing: border-box; - overflow: hidden; -} +/* Fallback */ +.markdown img[src$="#hero-br"], +article img[src$="#hero-br"] { + width: 100%; height: auto; display: block; margin: 0; + box-sizing: border-box; + padding: 0 clamp(16px, 6vw, 56px) clamp(12px, 4vw, 36px) 0; + background: #F1F3F3; + border-radius: 12px; + border: 1px solid #EAEBEB; + object-fit: cover; + box-shadow: 0px 2px 4px -1px rgba(41,47,61,0.04), 0px 4px 6px -1px rgba(41,47,61,0.05); +} +[data-theme="dark"] .markdown img[src$="#hero-br"], +[data-theme="dark"] article img[src$="#hero-br"] { background: #202B3D; border-color: #2E3A4F; } +@supports (selector(:has(*))) { + .markdown p:has(> img[src$="#hero-br"]), + article p:has(> img[src$="#hero-br"]) { + max-width: 841px; + padding: 0 clamp(16px, 6vw, 56px) clamp(12px, 4vw, 36px) 0; + background: #F1F3F3; border-radius: 12px; box-sizing: border-box; overflow: hidden; + } + [data-theme="dark"] .markdown p:has(> img[src$="#hero-br"]), + [data-theme="dark"] article p:has(> img[src$="#hero-br"]) { background: #202B3D; } + .markdown img[src$="#hero-br"], + article img[src$="#hero-br"] { + padding: 0; background: transparent; + border-radius: 0 0 8px 0; border-width: 0 1px 1px 0; border-style: solid; border-color: #EAEBEB; + } + [data-theme="dark"] .markdown img[src$="#hero-br"], + [data-theme="dark"] article img[src$="#hero-br"] { border-color: #2E3A4F; } +}Please verify:
- Rendering on iOS Safari 14/15 and Chrome 100 (no
:has) shows padded, rounded hero blocks.- Dark mode hero blocks use the new dark background/border colors.
- Small screens don’t feel cramped due to
clamp()paddings.
🧹 Nitpick comments (2)
src/css/custom.css (2)
773-799: Consider removing deprecated center-image CSS or add a deprecation note.The old
img[src*="#center"]rules are fully commented out. If the migration to hero variants is complete, delete them to reduce noise; otherwise add a short comment with removal timeline.
1026-1030: Sidebar caret height may misalign with existing min-heights.Earlier rules set caret pseudo-elements min-height: 29.5px; this new 28px on
menu__link--sublist-caretcan cause vertical misalignment at level 2.Apply this tweak to align both the element and pseudo-elements for level‑2:
.theme-doc-sidebar-item-category-level-2 > .menu__list-item-collapsible > .menu__link--sublist-caret{ - height: 28px; + height: 28px; + line-height: 28px; } +/* Ensure caret pseudo-elements match level-2 row height */ +.theme-doc-sidebar-item-category-level-2 .menu__caret:before, +.theme-doc-sidebar-item-category-level-2 .menu__link--sublist:after { + min-height: 28px; +}Please check vertical centering for level‑2 rows in light/dark modes and on mobile.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
src/css/custom.css(3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Cursor Bugbot
Description
Type of Change
Summary by CodeRabbit
Documentation
Style