Răsfoiți Sursa

docs(jetbrains): add JCEF troubleshooting guide (#2506)

This commit introduces a new markdown file, `jetbrains-troubleshooting.md`, which details common issues and solutions for using Kilo Code within JetBrains IDEs, with a specific focus on JCEF (Java Chromium Embedded Framework) support.

The file includes instructions for enabling JCEF in various JetBrains IDEs, troubleshooting steps, and a visual guide for Android Studio.

Additionally, the JetBrains plugin's `RooToolWindowFactory.kt` has been updated to link directly to this new troubleshooting guide from the JCEF warning message, improving user guidance.

Co-authored-by: Chris Hasson <[email protected]>
Chris Hasson 5 luni în urmă
părinte
comite
62307990ea

+ 91 - 0
apps/kilocode-docs/docs/jetbrains-troubleshooting.md

@@ -0,0 +1,91 @@
+# JetBrains Plugin Troubleshooting
+
+This guide covers common issues when using Kilo Code in JetBrains IDEs (IntelliJ IDEA, Android Studio, WebStorm, PyCharm, etc.).
+
+## Known Missing Features
+
+The following features, available in the VS Code version of Kilo Code, are not currently implemented in the JetBrains version:
+
+- **Autocomplete/QuickTasks**
+- **Git Commit Message Generation** This feature is missing but will be added soon!
+
+We're actively working on bringing feature parity between the VS Code and JetBrains versions. Check our [GitHub repository](https://github.com/Kilo-Org/kilocode) for updates on development progress.
+
+## JCEF (Java Chromium Embedded Framework) Issues
+
+### What is JCEF?
+
+JCEF (Java Chromium Embedded Framework) is required for Kilo Code's web-based interface to display properly in JetBrains IDEs. Most JetBrains IDEs include JCEF support by default, but some configurations may need manual activation.
+
+## Fixing JCEF Issues by IDE
+
+### Android Studio
+
+JCEF is available in Android Studio but may need to be enabled manually:
+
+1. **Open Settings/Preferences:**
+
+    - **Windows/Linux:** File → Settings
+    - **macOS:** Help → Find Action...
+
+2. **Navigate to Boot Java Runtime:**
+
+    - Choose Boot Java Runtime for the IDE...
+
+3. **Pick a new runtime**
+
+    - Pick one that has "with JCEF" in the name
+
+4. **Restart Android Studio:**
+
+    - Close and reopen Android Studio for the changes to take effect
+
+5. **Verify:**
+    - Open Kilo Code panel
+    - The JCEF warning should be gone, and the interface should load properly
+
+**Visual Guide:**
+
+<img src="/docs/img/jetbrains/android-studio-jcef-enable.gif" alt="Step-by-step guide showing how to enable JCEF in Android Studio" width="600" />
+
+_This animation shows the complete process of enabling JCEF in Android Studio._
+
+### IntelliJ IDEA
+
+JCEF should be enabled by default in IntelliJ IDEA. If you see JCEF warnings:
+
+1. **Update IntelliJ IDEA:**
+
+    - Ensure you're running the latest version
+    - Go to Help → Check for Updates
+
+2. **Verify JetBrains Runtime:**
+
+    - IntelliJ IDEA should use JetBrains Runtime (JBR) by default
+    - JBR includes JCEF support
+
+3. **Check Advanced Settings:**
+    - Go to File → Settings (Windows/Linux) or IntelliJ IDEA → Preferences (macOS)
+    - Navigate to Advanced Settings
+    - Look for any JCEF-related options and ensure they're enabled
+
+### Other JetBrains IDEs
+
+For WebStorm, PyCharm, PhpStorm, RubyMine, CLion, GoLand, DataGrip, and Rider:
+
+1. **Update to Latest Version:**
+
+    - Most JCEF issues are resolved in recent versions
+    - Use the built-in updater: Help → Check for Updates
+
+2. **Verify JetBrains Runtime:**
+
+    - These IDEs should use JetBrains Runtime by default
+    - JBR includes comprehensive JCEF support
+
+3. **Check Settings:**
+    - Go to File → Settings (Windows/Linux) or [IDE Name] → Preferences (macOS)
+    - Navigate to Advanced Settings
+    - Enable any JCEF-related options
+
+_For general Kilo Code support and documentation, visit [kilocode.ai/docs](https://kilocode.ai/docs)_

BIN
apps/kilocode-docs/static/img/jetbrains/android-studio-jcef-enable.gif


+ 2 - 2
jetbrains/plugin/src/main/kotlin/ai/kilocode/jetbrains/ui/RooToolWindowFactory.kt

@@ -99,7 +99,7 @@ class RooToolWindowFactory : ToolWindowFactory {
             val isLinuxArm = osName.lowercase().contains("linux") && (osArch.lowercase().contains("aarch64") || osArch.lowercase().contains("arm"))
             
             return buildString {
-                append("<html><body style='width: 300px;'>")
+                append("<html><body style='width: 300px; padding: 8px;'>")
                 append("<p>Kilo Code is initializing...")
                 append("<h3>System Information</h3>")
                 append("<table>")
@@ -124,7 +124,7 @@ class RooToolWindowFactory : ToolWindowFactory {
                     append("<div style='background-color: #f8d7da; border: 1px solid #f5c6cb; padding: 10px; border-radius: 4px; color: #721c24;'>")
                     append("<b>⚠️ JCEF Not Supported</b><br>")
                     append("Your IDE runtime does not support JCEF. Please use a JCEF-enabled runtime.<br>")
-                    append("See known issues doc for more information.")
+                    append("<a href='https://kilocode.ai/docs/jetbrains-troubleshooting' target='_blank' style='color: #721c24; text-decoration: underline;'>See JetBrains docs for how to enable JCEF in your IDE</a>")
                     append("</div>")
                     append("<br>")
                 }