Skip to content

Conversation

@danciaclara
Copy link
Collaborator

@danciaclara danciaclara commented Nov 10, 2025


Note

Adds a new Keyboard shortcuts docs page and links it in the sidebar; updates Get help page frontmatter.

  • Documentation:
    • New page: docs/support/keyboard-shortcuts.mdx with comprehensive shortcut listings.
    • Get help: Adds frontmatter metadata to docs/support/get-help.mdx.
  • Navigation:
    • Sidebar: Adds support/keyboard-shortcuts under Support and resources in sidebars.ts.

Written by Cursor Bugbot for commit 53a5d5a. This will update automatically on new commits. Configure here.

Summary by CodeRabbit

  • Documentation
    • Added a new keyboard shortcuts reference guide featuring comprehensive coverage of work item, cycle, module, page, and initiative actions, along with navigation and creation shortcuts with platform-specific support (Mac/Windows/Linux)
    • Enhanced support documentation metadata structure for better discoverability
    • Updated navigation to include keyboard shortcuts in support resources

@vercel
Copy link

vercel bot commented Nov 10, 2025

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

Project Deployment Preview Comments Updated (UTC)
docs Ready Ready Preview Comment Nov 10, 2025 10:36am

Copy link

@cursor cursor bot left a comment

Choose a reason for hiding this comment

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

This PR is being reviewed by Cursor Bugbot

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.

| Open a teamspace | `O` then `T` |
| Open an initiative | `O` then `N` |
| Open a customer record | `O` then `U` |
| Open a workspace setting | `O` then `S` |
Copy link

Choose a reason for hiding this comment

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

Bug: Keyboard Shortcuts: Settings Conflict

Both Open a project setting and Open a workspace setting are mapped to the same shortcut O then S, creating a conflict. Keyboard shortcuts must be unique - the application cannot execute two different actions from the same key combination.

Fix in Cursor Fix in Web

| Go to project settings | `G` then `S` |
| Go to project archives | `G` then `R` |
| Go to workspace analytics | `G` then `A` |
| Go to workspace settings | `G` then `S` |
Copy link

Choose a reason for hiding this comment

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

Bug: Conflicting Keyboard Shortcuts

Both Go to project settings and Go to workspace settings are mapped to the same shortcut G then S, creating a conflict. Keyboard shortcuts must be unique - the application cannot execute two different actions from the same key combination.

Fix in Cursor Fix in Web

| Go to workspace analytics | `G` then `A` |
| Go to workspace settings | `G` then `S` |
| Go to workspace drafts | `G` then `J` |
| Go to workspace archives | `G` then `R` |
Copy link

Choose a reason for hiding this comment

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

Bug: Conflicting Shortcuts Break Navigation

Both Go to project archives and Go to workspace archives are mapped to the same shortcut G then R, creating a conflict. Keyboard shortcuts must be unique - the application cannot execute two different actions from the same key combination.

Fix in Cursor Fix in Web

@coderabbitai
Copy link

coderabbitai bot commented Nov 10, 2025

Note

Other AI code review bot(s) detected

CodeRabbit 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.

Walkthrough

Documentation enhancements were made to the support section: YAML front matter is added to the get-help page, a new keyboard-shortcuts documentation page is created containing comprehensive action-shortcut mappings across multiple Plane features, and the sidebar navigation is updated to include the new keyboard-shortcuts entry.

Changes

Cohort / File(s) Summary
Documentation front matter
docs/support/get-help.mdx
Added YAML front matter with title and support channel description
New keyboard shortcuts page
docs/support/keyboard-shortcuts.mdx
New documentation page listing keyboard shortcuts organized by feature (Work items, Cycles, Modules, Pages, Initiatives, Create, Navigate, Miscellaneous) with modifier key legend
Navigation configuration
sidebars.ts
Added "support/keyboard-shortcuts" entry to the Support and resources section

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

  • Verify YAML front matter syntax and metadata correctness in get-help.mdx
  • Check keyboard shortcuts content accuracy and table formatting consistency
  • Confirm sidebar navigation link path matches the new documentation file location and integrates properly

Poem

🐰 Hop, hop! New shortcuts we've found,
Documentation trails all around,
Keyboard commands mapped with care,
Navigation breadcrumbs everywhere—
Help flows swift on little paws! 🌿

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Keyboard shortcuts' directly corresponds to the main change: adding keyboard shortcuts documentation to the project.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch keyboard-shortcuts

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bcc073e and 53a5d5a.

📒 Files selected for processing (3)
  • docs/support/get-help.mdx (1 hunks)
  • docs/support/keyboard-shortcuts.mdx (1 hunks)
  • sidebars.ts (1 hunks)
🔇 Additional comments (8)
docs/support/keyboard-shortcuts.mdx (6)

1-8: LGTM!

The front matter and introduction are well-structured. The description clearly conveys the purpose of the page, and the introduction appropriately mentions the global shortcut to access this list.


10-27: LGTM!

The work item actions are comprehensive and well-organized. The shortcuts use a logical pattern with single keys for frequent actions and modifiers for more specialized operations.


28-61: LGTM!

The action-specific shortcuts are well-organized across cycles, modules, pages, and initiatives. The reuse of shortcuts like S and L across different contexts is acceptable if these are context-dependent (i.e., only active when the respective entity is in focus).


62-76: LGTM!

The create shortcuts follow a consistent pattern (N then a second key). All shortcuts are unique within this section, and the pattern makes them easy to remember and discover.


113-120: LGTM!

The miscellaneous shortcuts are clear and serve important app-level functions. The ⌘ + / shortcut correctly matches the one mentioned in the introduction.


121-123: LGTM!

The modifier key legend is helpful and clearly explains the symbols used throughout the documentation for different operating systems.

sidebars.ts (1)

325-325: LGTM!

The navigation entry is correctly added to the "Support and resources" section. The path matches the new documentation file and follows the existing pattern for sidebar entries.

docs/support/get-help.mdx (1)

1-4: LGTM!

The front matter addition properly aligns this page with the documentation site's metadata structure. The title and description accurately reflect the page content and are consistent with the pattern used in the new keyboard-shortcuts page.


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.

@sriramveeraghanta sriramveeraghanta merged commit 162cd53 into master Nov 10, 2025
4 checks passed
@sriramveeraghanta sriramveeraghanta deleted the keyboard-shortcuts branch November 10, 2025 12:15
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.

3 participants