Skip to content

Quick Documentation not working as expected (Rider) #154

@tvalebjorg

Description

@tvalebjorg

Hello @lppedd!

I'm encountering an issue with the "Quick Documentation" feature (invoked via Ctrl+K, I or by right-clicking and selecting Quick Documentation) when using the Conventional Commit plugin in JetBrains Rider.

Description:

When I explicitly try to invoke the Quick Documentation on a highlighted commit type or scope suggestion in the commit message window, a small popup appears at the top of the commit message window with the text 'Quick Documentation': getting the action ready... and it remains stuck in this state indefinitely. Pressing Esc cancels this message, and no documentation pane is displayed.

Image

The expected documentation/definition pane on the right (as seen in the readme) does not appear.

Steps to reproduce:

  • Ensure the Conventional Commit plugin is installed and enabled in JetBrains Rider.
  • Have a conventionalcommit.json file loaded and recognized by the plugin (suggestions for types and scopes appear correctly).
  • Open the Git Commit window in Rider.
  • Trigger the Conventional Commit suggestions (ctrl + space).
  • Highlight a suggestion (commit type or scope).
  • Press Ctrl+K, I or right-click on the highlighted suggestion and select Quick Documentation.
  • Observe the 'Quick Documentation': getting the action ready... message appear at the top, but no documentation pane shows.

Important Note: This issue occurs even when using the default conventionalcommit.json configuration that comes with the plugin, not just with a custom configuration. The "getting the action ready" message appears only when explicitly trying to invoke the Quick Documentation feature.

Expected behavior:

As demonstrated in the readme, when invoking Quick Documentation on a suggestion, a pane with the description of the selected commit type or scope should appear on the right-hand side of the suggestions list.

Environment:

Conventional Commit Plugin Version: 0.24.1
JetBrains Rider 2024.3.7
Build #RD-243.26053.56, built on April 3, 2025
Runtime version: 21.0.6+8-b631.39 amd64 (JCEF 122.1.9)
VM: OpenJDK 64-Bit Server VM by JetBrains s.r.o.
Toolkit: sun.awt.windows.WToolkit
Windows 11.0
.NET Core v8.0.11 x64 (Server GC)
GC: G1 Young Generation, G1 Concurrent GC, G1 Old Generation
Memory: 2048M
Cores: 22

Registry:

  • ide.experimental.ui=true
  • llm.show.ai.promotion.window.on.start=false

Non-Bundled Plugins:

  • com.github.lppedd.idea-conventional-commit (0.24.1)
  • nsubstitutecomplete-rider (2024.3.0)
  • com.intellij.ml.llm (243.23654.270.16)
  • com.github.copilot (1.5.41-243)

Additional context:

The core suggestion functionality of the plugin works as expected. The issue is specifically with the explicit invocation of the "Quick Documentation" feature in Rider, and it's not related to a custom conventionalcommit.json file.

I'm happy to provide any further information or logs that might be helpful in diagnosing this issue.

Thank you for your work on this useful plugin!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions