Updated title tags, added Sync plan and Draw.io integration #367
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. WalkthroughFront-matter and title refinements applied across 50+ MDX docs to add descriptive titles, sidebar_label fields, and expanded descriptions; a new Draw.io integration guide was added; AI docs updated to reflect Plane AI creation/editing and advanced action execution; license management content expanded; sidebar ordering adjusted. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10–15 minutes
Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
⏰ 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)
🔇 Additional comments (2)
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 |
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
This is the final PR Bugbot will review for you during this billing cycle
Your free Bugbot reviews will reset on November 20
Details
Your team is on the Bugbot Free tier. On this plan, Bugbot will review limited PRs each billing cycle for each member of your team.
To receive Bugbot reviews on all of your PRs, visit the Cursor dashboard to activate Pro and start your 14-day free trial.
|  | ||
|
|
||
| ## Delink license | ||
| Here's a shorter version: |
There was a problem hiding this comment.
Bug: Draft Content Accidentally Published
The text Here's a shorter version: appears to be leftover editorial/draft content accidentally included in the documentation. This looks like a personal note meant to be removed before publishing.
![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
🧹 Nitpick comments (3)
docs/ai/pi-chat.mdx (1)
2-2: Minor: Hyphenate compound adjective.Line 2 should use a hyphenated form when "AI powered" functions as a compound adjective before the noun "assistant": "AI-powered assistant for project management".
-title: AI powered assistant for project management +title: AI-powered assistant for project managementdocs/communication-and-collaboration/project-updates.mdx (1)
2-4: Consider shortening the page title for clarity and SEO. The title "Project updates to share status and track progress" is verbose. A concise version like "Project Updates" or "Share project status with updates" would improve readability while maintaining SEO value and aligning better with the sidebar_label approach.docs/workspaces-and-users/manage-licenses.mdx (1)
33-33: Remove or clarify the introductory phrase "Here's a shorter version:". This phrase lacks context—shorter than what? It appears to be an editing artifact. Either remove it or replace with a more descriptive transition like "Sync your plan regularly to ensure your workspace reflects the latest subscription details."
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (69)
docs/ai/pi-chat.mdx(4 hunks)docs/ai/plane-ai-credits.mdx(2 hunks)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/analytics.mdx(1 hunks)docs/core-concepts/cycles.mdx(1 hunks)docs/core-concepts/deploy.mdx(1 hunks)docs/core-concepts/export.mdx(1 hunks)docs/core-concepts/inbox.mdx(1 hunks)docs/core-concepts/intake.mdx(1 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(1 hunks)docs/core-concepts/issues/estimates.mdx(1 hunks)docs/core-concepts/issues/labels.mdx(1 hunks)docs/core-concepts/issues/layouts.mdx(1 hunks)docs/core-concepts/issues/time-tracking.mdx(1 hunks)docs/core-concepts/issues/timeline-dependency.mdx(1 hunks)docs/core-concepts/issues/visualise_filter.mdx(1 hunks)docs/core-concepts/modules.mdx(1 hunks)docs/core-concepts/pages/editor-blocks.mdx(2 hunks)docs/core-concepts/pages/inline-comments.mdx(1 hunks)docs/core-concepts/pages/nested-pages.mdx(1 hunks)docs/core-concepts/pages/overview.mdx(1 hunks)docs/core-concepts/pages/wiki.mdx(1 hunks)docs/core-concepts/projects/initiatives.mdx(1 hunks)docs/core-concepts/projects/manage-project-members.mdx(1 hunks)docs/core-concepts/projects/milestones.mdx(1 hunks)docs/core-concepts/projects/overview.mdx(1 hunks)docs/core-concepts/projects/recurring-work-items.mdx(1 hunks)docs/core-concepts/stickies.mdx(1 hunks)docs/core-concepts/views.mdx(1 hunks)docs/core-concepts/workspaces/members.mdx(1 hunks)docs/core-concepts/workspaces/overview.mdx(1 hunks)docs/core-concepts/workspaces/teamspaces.mdx(1 hunks)docs/customers.mdx(1 hunks)docs/dashboards.mdx(1 hunks)docs/devices/mobile.mdx(1 hunks)docs/importers/asana.mdx(1 hunks)docs/importers/clickup.mdx(1 hunks)docs/importers/confluence.mdx(1 hunks)docs/importers/csv.mdx(1 hunks)docs/importers/jira.mdx(1 hunks)docs/importers/linear.mdx(1 hunks)docs/importers/notion.mdx(1 hunks)docs/importers/overview.mdx(1 hunks)docs/intake/intake-email.mdx(1 hunks)docs/intake/intake-forms.mdx(1 hunks)docs/integrations/about.mdx(1 hunks)docs/integrations/draw-io.mdx(1 hunks)docs/integrations/github.mdx(1 hunks)docs/integrations/gitlab.mdx(1 hunks)docs/integrations/sentry.mdx(1 hunks)docs/integrations/slack.mdx(1 hunks)docs/introduction/home.mdx(1 hunks)docs/introduction/quickstart.mdx(1 hunks)docs/support/get-help.mdx(1 hunks)docs/support/keyboard-shortcuts.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)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)sidebars.ts(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/workspaces-and-users/manage-licenses.mdx
[style] ~37-~37: Consider shortening or rephrasing this to strengthen your wording.
Context: ...orter version: ## Sync plan If you've made changes to your subscription, like renewing your l...
(MAKE_CHANGES)
⏰ 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 (72)
docs/support/get-help.mdx (1)
2-3: Well-structured front-matter updates that improve navigation and discoverability.The new
sidebar_labelfield enhances navigation UX by keeping the sidebar concise ("Get help") while the expandedtitle("Support and help resources") better describes the page's comprehensive scope. This pattern follows documentation best practices for balancing brevity with clarity.docs/core-concepts/projects/milestones.mdx (1)
2-3: Documentation metadata updates are well-structured and consistent with best practices.The enhanced title provides better user context and SEO value, while the
sidebar_labelfield enables cleaner navigation UI by allowing the sidebar to display a shorter label ("Milestones") while the full page title remains descriptive. The YAML front matter is syntactically valid and properly formatted.docs/support/keyboard-shortcuts.mdx (1)
2-3: Enhanced front-matter titles and navigation labels. ✓The title expansion from "Keyboard shortcuts" to "Complete list of keyboard shortcuts and hotkeys" is more descriptive and helps readers understand the breadth of content. The new
sidebar_labelfield ("Keyboard shortcuts") provides a concise, scannable navigation label while the full title remains in the page heading—a good pattern for documentation sites.Both changes improve discoverability and navigation without affecting the content itself.
docs/devices/mobile.mdx (1)
2-3: Front matter enhancements are aligned with PR objectives.The title now provides more descriptive context for SEO and clarity, and the
sidebar_labeladdition improves navigation consistency. These metadata-only changes have no impact on content or rendering.docs/ai/plane-ai-credits.mdx (2)
2-6: Documentation metadata improvements look great.The enhanced title, sidebar label, and description provide better discoverability and context for users navigating the docs. The front-matter updates are concise and accurately reflect the content.
37-37: Terminology updated consistently across the document.The change from "issues" to "work items" aligns with the terminology used elsewhere in the document (lines 23, 46) and provides a more inclusive, modern term for the concept.
docs/customers.mdx (1)
2-5: Metadata updates enhance discoverability and documentation clarity.The front matter changes strengthen the documentation structure:
- Title now descriptively summarizes the feature's purpose ("Customer management to track client requests and priorities"), improving SEO and context.
- sidebar_label ("Customers") provides concise navigation labels.
- Description clearly outlines key capabilities and helps users understand the value proposition.
The metadata aligns well with the content structure and the headline at line 11. The hide_title configuration correctly hides the front matter title while allowing the custom h1 element in the body to display.
docs/core-concepts/issues/timeline-dependency.mdx (1)
10-10: Heading change is clear and specific.The heading now explicitly references "Timeline layout," which improves clarity and aligns well with the content. This complements the documentation's focus on timeline connectors and visual dependency setup.
docs/core-concepts/projects/overview.mdx (2)
1-7: Metadata updates align well with page content and heading.The front-matter changes improve clarity and navigation:
- Title now accurately reflects the page's scope ("Create and manage projects" vs. "Manage projects")
- h1 heading (line 7) matches the new title, maintaining consistency
- sidebar_label provides a concise navigation label
1-5: No issues found—sidebar_label pattern is correctly applied and consistent.The verification confirms that the file under review correctly applies
sidebar_label("Manage projects") as a shorter, navigation-friendly version of the full title ("Create and manage projects"). Across the codebase, 30 of 43 files indocs/core-conceptsfollow this same convention, and all files withsidebar_labeluse it consistently to provide concise sidebar navigation labels. The selective application across the batch (70% adoption) appears intentional by design, not an error or incomplete batch application.docs/intake/intake-email.mdx (1)
1-6: Front-matter improvements approved.The updated title is descriptive and action-oriented, and the sidebar_label provides clear navigation affordance. This aligns well with the broader intake documentation updates.
docs/importers/linear.mdx (1)
1-5: Front-matter updated consistently with importer documentation standards.Title follows the "Import data from [X]" naming convention, and sidebar_label is appropriately concise for navigation.
docs/importers/notion.mdx (1)
1-5: Front-matter updated consistently with importer documentation standards.Title aligns with the "Import data from [X]" convention, and sidebar_label supports clear navigation.
docs/core-concepts/deploy.mdx (1)
1-6: Verify title-content alignment for singular vs. plural.The title "Publish projects" (plural) reads as describing a general capability, but the page instructions focus on publishing a single project at a time. Consider whether the singular "Publish project" would better match the instructional flow, or confirm the plural is intentional to emphasize the capability applies to any/all projects.
docs/core-concepts/export.mdx (1)
1-5: Front-matter improvements approved.The updated title is clear and descriptive, and the sidebar_label provides appropriate navigation. Title accurately reflects the capability to export from a project context.
docs/importers/confluence.mdx (1)
1-5: Front-matter updated consistently with importer documentation standards.Title follows the established "Import data from [X]" convention, and sidebar_label is appropriately concise for navigation.
docs/importers/asana.mdx (1)
1-5: Front-matter updated consistently with importer documentation standards.Title aligns with the "Import data from [X]" convention, and sidebar_label supports clear navigation.
docs/integrations/github.mdx (1)
1-6: Front-matter improvements approved.The updated title is descriptive and action-oriented, clearly communicating the integration's core functionality. The sidebar_label is concise and appropriate for navigation, and the description has been enriched for better discoverability.
docs/core-concepts/issues/time-tracking.mdx (1)
2-3: Front-matter update looks good.The new descriptive title improves SEO and search discoverability, while the sidebar_label maintains a clean, concise navigation label. The hide_title field ensures the h1 in the content ("Log time on work items") displays to users rather than the verbose title.
docs/core-concepts/pages/nested-pages.mdx (1)
2-3: Front-matter update is consistent and well-structured.The descriptive title and sidebar_label follow the same pattern as other updated pages, balancing SEO metadata with clean navigation and user-friendly h1 headers.
docs/core-concepts/issues/layouts.mdx (1)
2-3: Front-matter update is valid, but verify hide_title consistency.The descriptive title and sidebar_label follow the established pattern. However, this file lacks a visible
hide_titlefield, unlike time-tracking.mdx and nested-pages.mdx. Confirm whether this is intentional or an inconsistency in the PR's standardization approach.docs/core-concepts/issues/display-options.mdx (1)
2-3: Front-matter update is valid; note hide_title inconsistency.Like layouts.mdx, this file does not show a
hide_titlefield, whereas earlier files (time-tracking, nested-pages) have it set to true. Ensure this inconsistency is intentional or if all files should standardize on either including or omitting the field.docs/introduction/quickstart.mdx (1)
2-3: Front-matter update is valid; hide_title behavior differs across files.This file's front-matter title ("Set up Plane for your team") matches the h1 in the content, and no
hide_titlefield is present. This differs from time-tracking and nested-pages, which usehide_title: trueand different h1 values. Clarify the intended behavior: should all files consistently use or omithide_title?docs/core-concepts/stickies.mdx (1)
2-3: Front-matter update is valid; hide_title behavior is inconsistent.The front-matter title differs from the content h1, similar to time-tracking.mdx and nested-pages.mdx. However, this file does not show a
hide_titlefield, whereas those earlier files have it explicitly set to true. Clarify the standardization across all 52+ files mentioned in the PR summary.docs/core-concepts/modules.mdx (1)
2-4: Front-matter update is valid; note hide_title inconsistency and description change.The title is more descriptive, sidebar_label is concise, and the description has been expanded—all good changes. However, like other files, the
hide_titlefield is not visible, yet the h1 differs from the front-matter title. Standardize the hide_title behavior across all updated files.docs/importers/overview.mdx (1)
2-3: Front-matter update is valid; hide_title inconsistency persists.Changing the title to "Importers overview" improves clarity and differentiates it from other "Overview" pages. The sidebar_label is concise and appropriate. However, the pattern of missing
hide_titlefields across most files (despite h1 headers differing from front-matter titles) suggests an inconsistency that should be addressed across the full PR scope.docs/importers/csv.mdx (1)
2-3: Metadata update improves discoverability and navigation clarity.The new title "Import data from CSV file" is more descriptive than the original and aligns with the importer naming pattern. The sidebar_label "CSV" provides concise navigation while the full title supports SEO and user clarity.
docs/dashboards.mdx (1)
2-3: Clear descriptive title enhances SEO and user guidance.The updated title "Custom dashboards to visualize project metrics and data" provides context about dashboard purpose and capabilities, improving discoverability. The sidebar_label maintains a concise navigation entry. Changes align well with the page's content on dashboard creation and customization.
docs/importers/clickup.mdx (1)
2-3: Consistent importer naming pattern improves predictability.The title "Import data from ClickUp" follows the established pattern across importers and clearly communicates purpose. The sidebar_label maintains navigation conciseness while the expanded title aids discoverability and user orientation.
docs/integrations/sentry.mdx (1)
2-3: Integration title communicates core value proposition.The new title "Integrate Sentry for automatic error tracking sync" is more descriptive than "Sentry" and highlights the key integration benefit. This supports better user understanding and SEO. The sidebar_label "Sentry" keeps navigation concise while the expanded title provides clarity in search and discovery contexts.
docs/integrations/about.mdx (1)
2-3: Scoped title eliminates ambiguity in documentation hierarchy.Changing "Overview" to "Integrations overview" provides context and prevents confusion when multiple overview pages exist. The sidebar_label "Overview" appropriately maintains concise navigation while the title clarifies the section context.
docs/core-concepts/projects/manage-project-members.mdx (1)
2-3: Scoped title clarifies project-level vs. workspace-level scope.The new title "Manage project members" differentiates this page from workspace-level member management, providing clearer navigation intent. The sidebar_label "Manage members" is appropriately concise. This update aligns with similar scoping done for workspace-level documentation.
docs/core-concepts/projects/initiatives.mdx (1)
2-5: Descriptive title and expanded description enhance feature clarity.The new title "Align multiple projects with Initiatives" immediately communicates the key use case and benefit. The expanded description emphasizes cross-project alignment and strategic goal tracking, providing useful context for users evaluating the feature. The sidebar_label remains concise and appropriate.
docs/core-concepts/issues/labels.mdx (1)
2-4: Action-oriented title and enriched description improve feature discoverability.The new title "Categorize and tag project tasks" is more descriptive than "Labels" and communicates feature purpose. The expanded description provides concrete use cases (filtering, organization by component/feature) and helps users understand when and how to use labels. The sidebar_label "Labels" remains appropriate for navigation. These changes significantly improve SEO and user onboarding.
docs/core-concepts/intake.mdx (1)
2-4: ✓ Approve metadata updates.The front-matter changes enhance discoverability with a descriptive title and sidebar label while preserving URL structure. The description expansion accurately reflects the page content. Metadata is complete and consistent with the intake documentation hierarchy (compare to intake-forms.mdx which uses the same title but a distinct sidebar_label).
docs/automations/custom-automations.mdx (1)
2-3: ✓ Approve metadata updates.Title and sidebar_label are appropriately descriptive. The existing hide_title flag and expanded description are preserved correctly. Metadata follows the consistent pattern established across documentation.
docs/workflows-and-approvals/workflows.mdx (1)
2-3: ✓ Approve metadata updates.Title now includes context about workflow functionality. Sidebar label clearly identifies the feature. Changes follow the consistent pattern and preserve the hide_title flag appropriately.
docs/integrations/gitlab.mdx (1)
2-3: ✓ Approve metadata updates.Integration title now uses action-oriented language following established pattern. Sidebar label correctly identifies the platform. Description scope is comprehensive, covering both cloud and self-managed GitLab deployments.
The PR summary mentions GitHub integration and Draw.io integration updates, as well as navigation reordering in sidebars.ts. These files were not provided for review. Please verify that:
- docs/integrations/github.mdx follows the same metadata pattern as GitLab
- docs/integrations/draw-io.mdx exists and is properly configured
- sidebars.ts correctly references all updated integration documents
docs/introduction/home.mdx (1)
2-4: ✓ Approve metadata updates with SEO optimization.Homepage title strategically uses marketing language ("Modern project management software") while preserving "Introduction" in sidebar_label for clear navigation. Slug is correctly preserved as "/", ensuring homepage routing remains intact. Description expansion appropriately emphasizes key value propositions.
docs/core-concepts/cycles.mdx (1)
2-3: ✓ Approve metadata updates.Title appropriately uses process-oriented language ("Manage sprints and track agile workflows") making the page purpose immediately clear. Sidebar label preserves the feature name for consistent navigation. Description comprehensively covers sprint management, progress tracking, and cross-project monitoring capabilities.
docs/core-concepts/pages/inline-comments.mdx (1)
2-3: ✓ Approve metadata updates.Title rephrased for clarity ("Inline comments for collaborative page discussions" vs "Page Inline Comments") improves discoverability while sidebar_label preserves the original compound noun for consistent navigation. Description scope appropriately covers Project, Wiki, and Teamspace contexts. Pattern is consistent with other documentation updates.
docs/intake/intake-forms.mdx (1)
2-3: ✓ Approve metadata updates with consistent hierarchy.Title matches parent intake documentation for consistency while sidebar_label distinguishes this page as "Intake Forms" (contrasting with parent "Intake" and sibling "Intake Email"). This creates a clear hierarchical structure where the parent provides conceptual overview and children provide specific implementations (forms, email). Pattern is appropriate and consistent.
The AI summary references docs/intake/intake-email.mdx with similar title but sidebar_label "Intake Email". This file was not provided for review. Please verify that intake-email.mdx follows the same metadata pattern to ensure consistency across the intake documentation hierarchy.
docs/core-concepts/analytics.mdx (1)
2-5: Front-matter updates look good.Clear, descriptive title that improves SEO and user context. Sidebar label maintains concise navigation label. Description effectively communicates feature value.
docs/core-concepts/pages/wiki.mdx (1)
2-5: Well-structured front-matter with good title expansion.The updated title clearly communicates the wiki's purpose. Sidebar label is appropriately concise. The existing hide_title: true with custom styled heading is a good pattern for maintaining visual consistency.
docs/core-concepts/issues/estimates.mdx (1)
2-5: Excellent descriptive title that sets clear expectations.The updated title immediately communicates the three estimate types available. Sidebar label is appropriately concise for navigation. Description accurately reflects the content structure.
docs/your-work.mdx (1)
2-5: Clear, benefit-focused title with balanced sidebar label.The updated title emphasizes the dashboard functionality and user benefits. Sidebar label maintains the familiar "Your Work" naming for navigation. Description effectively outlines key features.
docs/core-concepts/projects/recurring-work-items.mdx (1)
2-5: Strong outcome-focused title with detailed description.The updated title highlights the automation benefit, improving discoverability and user motivation. Sidebar label uses appropriate title case. Description includes concrete use cases (maintenance schedules, routine work) that help users understand applicability.
docs/core-concepts/issues/visualise_filter.mdx (1)
2-4: Functional update with different title pattern.The title simplification to "Filter work items" uses an action-oriented approach, which differs from the more descriptive pattern in other files. While valid, consider whether this should align with the broader documentation pattern (e.g., "Filter work items with multiple conditions and advanced operators" for consistency). The sidebar_label "Work Item Filters" is appropriate but slightly longer than the title—ensure this is intentional.
docs/core-concepts/views.mdx (1)
2-4: Strong benefit-focused title with concise navigation label.The updated title emphasizes the action and benefit ("Save custom views for filtered work items"), improving user context and SEO. Sidebar label maintains concise, recognizable naming. Existing description effectively supports the updated title.
docs/core-concepts/pages/overview.mdx (1)
2-3: Verify title and sidebar_label alignment.The updated title "Pages for project documentation" emphasizes the feature type, while the sidebar_label "Manage project pages" emphasizes the action. This inverse relationship differs from other files in the PR where sidebar_label is typically the concise brand/feature name and the title is more descriptive. Consider whether sidebar_label should be "Pages" or updated to align with the title's feature focus for consistency.
docs/core-concepts/account/overview.mdx (1)
2-3: Front-matter update improves discoverability in navigation.The title enhancement ("Personalize your homepage") and sidebar_label addition follow the PR's pattern of improving metadata for better navigation. The sidebar label uses the simpler original phrasing, which is an appropriate distinction.
docs/templates/work-item-templates.mdx (1)
2-3: Title enhancement aligns with template documentation pattern.The title now describes the use case ("for recurring tasks") and sidebar_label provides a simpler navigation label. This approach is consistent with parallel updates to project-templates and page-templates in the same PR.
docs/templates/page-templates.mdx (1)
2-3: Front-matter update maintains consistency with template documentation pattern.The descriptive title and sidebar_label follow the same approach used in work-item-templates.mdx and align with the PR's metadata harmonization effort.
docs/templates/project-templates.mdx (1)
2-3: Front-matter updates are consistent with related template documentation.The pattern of using descriptive titles with simpler sidebar_labels is applied consistently across all three template pages (project, page, and work-item templates).
docs/importers/jira.mdx (1)
2-4: Front-matter and heading improvements clarify Jira import options.The updated title, description, and heading now explicitly mention all three supported Jira deployment types (Cloud, Server, Data Center), making the scope clearer and improving SEO discoverability.
Also applies to: 7-9
docs/ai/pi-chat.mdx (2)
2-3: Front-matter updates enhance title descriptiveness.The updated title "AI powered assistant for project management" is more specific than the original "Plane AI" and improves SEO discoverability. The sidebar_label appropriately simplifies navigation.
32-36: Clarify bulk operations capability status and section structure.The section "What Plane AI cannot do (yet)" has conflicting messaging:
- The section header implies these are current limitations ("cannot do")
- Line 55 states Plane AI "can now create and edit work items..."
- Yet line 58 lists "Handle bulk operations" as something the AI cannot do
- However, line 247 lists "Handle bulk operations" under "What's coming next" (future features)
This creates ambiguity: is bulk operations a current limitation or a planned future feature? The current structure could confuse readers about the actual state of capabilities.
Consider restructuring this section for clarity. One approach:
-## What Plane AI cannot do (yet) +## Current limitations -While Plane AI can now create and edit work items, projects, cycles, and modules, some capabilities are still in development: +Plane AI can create and edit work items, projects, cycles, and modules. However, these capabilities are not yet available: -- ❌ Execute complex automated workflows -- ❌ Handle bulk operations across multiple items simultaneouslyThis separates what the AI can do (stated positively above) from specific limitations being worked on.
Also applies to: 55-58
docs/core-concepts/workspaces/teamspaces.mdx (1)
2-3: Title enhancement improves navigation clarity.The updated title "Track team work with Teamspaces" is more descriptive than the standalone "Teamspaces" and follows the pattern established in other workspace documentation files.
docs/core-concepts/workspaces/overview.mdx (1)
2-3: Title expansion better reflects content scope.The updated title "Create and manage workspaces" is more accurate than "Manage workspace" since the page covers both creation and management workflows. Sidebar_label remains appropriately simple.
docs/core-concepts/pages/editor-blocks.mdx (1)
2-3: LGTM! Metadata improvements enhance navigation.The updated title provides clearer context ("Editor blocks for pages"), and the new
sidebar_labelfield helps maintain concise sidebar navigation while the full title improves SEO and page clarity.docs/integrations/slack.mdx (1)
2-3: LGTM! Descriptive title improves discoverability.The expanded title clearly communicates the integration's capabilities (sync threads, create work items), while the
sidebar_labelkeeps the navigation clean. This aligns well with the overall documentation metadata improvements in this PR.sidebars.ts (1)
246-250: LGTM! Navigation reordering highlights the new Draw.io integration.The new
integrations/draw-ioentry is appropriately placed at the top of Native integrations, giving visibility to the newly added integration, while Slack is repositioned to the end but remains accessible.docs/core-concepts/issues/bulk-ops.mdx (1)
2-3: LGTM! Metadata enhancements improve user experience.The descriptive title communicates the feature's value proposition clearly, while the
sidebar_labelmaintains navigation brevity. This aligns with the documentation-wide metadata improvements in this PR.docs/core-concepts/issues/epics.mdx (1)
2-3: LGTM! Clear title communicates the feature's purpose.The updated title effectively describes what Epics do ("Organize related work items"), improving discoverability and user understanding, while the
sidebar_labelkeeps navigation concise.docs/communication-and-collaboration/comments-and-activity.mdx (1)
2-4: LGTM! Comprehensive title and description enhance documentation.The expanded title ("Comments for collaboration and activity tracking") and new description effectively communicate the dual purpose of this feature, improving SEO and user comprehension.
docs/core-concepts/inbox.mdx (1)
2-3: LGTM! Descriptive title clarifies the Inbox feature.The updated title clearly explains what the Inbox contains ("in app notifications and work item updates"), improving user understanding while the
sidebar_labelmaintains clean navigation.docs/workspaces-and-users/upgrade-plan.mdx (1)
2-4: LGTM! Enhanced metadata provides comprehensive context.The updated title and expanded description effectively communicate the scope of plan upgrades, including self-hosted considerations and subscription management, improving documentation completeness.
docs/workspaces-and-users/search-workspace.mdx (1)
2-7: Consistent and user-friendly title updates. The personalized phrasing ("Search your workspace") and aligned sidebar_label improve navigation clarity and user-centeredness without affecting content.docs/workspaces-and-users/manage-licenses.mdx (2)
35-47: Sync plan section is clear and actionable. The step-by-step instructions for syncing subscription updates are well-structured and address a real user need. The guidance on when to use this feature (mismatches vs. external changes) is helpful.
49-64: Delink license key section is comprehensive. The expansion with practical multi-step instructions (delink, restart, move, reactivate) provides users with a clear path for license mobility across machines and workspaces.docs/core-concepts/workspaces/members.mdx (1)
2-3: Title clarification improves discoverability. Adding "workspace" to the title distinguishes this page from project-level member management and provides clear scope indication. The sidebar_label remains concise while the full title adds necessary context.docs/integrations/draw-io.mdx (1)
1-37: Well-structured new Draw.io integration guide. The documentation follows integration guide patterns with clear prerequisites, step-by-step setup, and helpful next-steps. The Business tier tag via component is properly applied. Instructions are specific and actionable (workspace settings menu, permission review, acceptance workflow).
| @@ -1,13 +1,13 @@ | |||
| --- | |||
| title: Timeline dependencies | |||
| title: Task dependencies | |||
There was a problem hiding this comment.
🧩 Analysis chain
Title change reduces specificity and may impact discoverability.
The title changed from "Timeline dependencies" to "Task dependencies," which is now generic despite the content being specific to Timeline layout. This creates a mismatch with:
- The filename:
timeline-dependency.mdx - The description: mentions "Timeline layout" explicitly
- The entire content: discusses only Timeline layout connectors and features
If task dependencies exist in other layouts (Board, List, etc.), this title could create confusion about scope. Users searching for "timeline dependencies" may not find this page.
Please verify: Do other layouts (Board, List, etc.) support task dependencies? If so, consider retaining the specificity:
-title: Task dependencies
+title: Timeline dependenciesAlternatively, if this page truly covers dependencies across all layouts, ensure the content and heading accurately reflect that broader scope.
I'll search the codebase to verify whether task dependencies are supported in other layouts beyond Timeline.
[/run_scripts]
🏁 Script executed:
#!/bin/bash
# Find all documentation files mentioning task dependencies or dependencies in general
echo "=== Searching for task dependency documentation ==="
find docs -type f \( -name "*.mdx" -o -name "*.md" \) -exec grep -l "task.*dependen\|dependen.*task\|dependencies.*layout" {} \; 2>/dev/null | head -20
echo ""
echo "=== Searching for Board/List layout documentation files ==="
find docs -type f \( -name "*.mdx" -o -name "*.md" \) | grep -E "(board|list|layout)" | head -20
echo ""
echo "=== Checking for any references to timeline-dependency content in other docs ==="
rg -l "timeline.*depend|task.*depend" docs --type mdx --type md 2>/dev/null
echo ""
echo "=== Listing all files in docs/core-concepts/issues ==="
ls -la docs/core-concepts/issues/ 2>/dev/nullLength of output: 1433
I need to examine the layouts.mdx and overview.mdx files to understand the scope of task dependency support.
[/run_scripts]
🏁 Script executed:
#!/bin/bash
# Read layouts.mdx to check what it says about Board/List layout features
echo "=== Content of layouts.mdx ==="
cat docs/core-concepts/issues/layouts.mdx
echo ""
echo "=== Content of overview.mdx (focusing on dependencies section) ==="
cat docs/core-concepts/issues/overview.mdx | head -100Length of output: 11988
Title change removes critical specificity—task dependencies are Timeline-exclusive.
Verification confirms that task dependencies (visual connectors) are a Timeline layout feature only. Other layouts (List, Board, Calendar, Table) do not support this feature. The documentation explicitly states: "Go for Timeline when managing dependencies or seeing the big picture."
The title change from "Timeline dependencies" to "Task dependencies" creates a harmful mismatch:
- Filename remains:
timeline-dependency.mdx - Content covers: Timeline layout only
- New title suggests: Feature applies across all layouts
- Result: Users searching for "timeline dependencies" won't find this page; generic title could mislead about scope
The heading change to "Set up task dependencies in Timeline layout" correctly adds specificity, but the title should also be restored to maintain consistency and discoverability.
Revert the title change:
-title: Task dependencies
+title: Timeline dependencies📝 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.
| title: Task dependencies | |
| title: Timeline dependencies |
🤖 Prompt for AI Agents
In docs/core-concepts/issues/timeline-dependency.mdx around line 2, the
frontmatter title was changed from "Timeline dependencies" to the generic "Task
dependencies" which misrepresents scope and hurts discoverability; revert the
frontmatter title back to "Timeline dependencies" so it matches the filename and
content, and ensure the visible H1 remains "Set up task dependencies in Timeline
layout" if desired for specificity.
| Plane supports importing from Jira Cloud, Jira Server, and Jira Data Center. Choose the import option that matches your Jira deployment. | ||
|
|
||
| :::info | ||
| The Jira importert is available on Plane Cloud and on all plans of the Commercial Edition for self-hosted instances. |
There was a problem hiding this comment.
Fix typo in info box.
Line 12 contains a typo: "Jira importert" should be "Jira importer".
-The Jira importert is available on Plane Cloud and on all plans of the Commercial Edition for self-hosted instances.
+The Jira importer is available on Plane Cloud and on all plans of the Commercial Edition for self-hosted instances.📝 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.
| The Jira importert is available on Plane Cloud and on all plans of the Commercial Edition for self-hosted instances. | |
| The Jira importer is available on Plane Cloud and on all plans of the Commercial Edition for self-hosted instances. |
🧰 Tools
🪛 LanguageTool
[grammar] ~12-~12: Ensure spelling is correct
Context: ...your Jira deployment. :::info The Jira importert is available on Plane Cloud and on all ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🤖 Prompt for AI Agents
In docs/importers/jira.mdx around line 12, the informational sentence contains a
typo: change "Jira importert" to "Jira importer" so the text reads "The Jira
importer is available on Plane Cloud and on all plans of the Commercial Edition
for self-hosted instances."
Description
Type of Change
Screenshots and Media (if applicable)
Test Scenarios
References
Note
Refreshes doc titles and navigation, adds Draw.io integration docs and editor guidance, updates AI capabilities, and introduces a license “Sync plan,” with sidebar updates.
title,sidebar_label, and descriptions across many pages for clearer navigation and discoverability.docs/integrations/draw-io.mdx.core-concepts/pages/editor-blocks.mdx.integrations/draw-io; adjust ordering.ai/pi-chat.mdx.ai/plane-ai-credits.mdx.workspaces-and-users/manage-licenses.mdx.sidebars.tsto surface Draw.io and adjust native integrations list.Written by Cursor Bugbot for commit 912a955. This will update automatically on new commits. Configure here.
Summary by CodeRabbit