Mirror: Add troubleshooting with console capture (#5865)#7
Mirror: Add troubleshooting with console capture (#5865)#7jeremylongshore merged 8 commits intomainfrom
Conversation
Co-authored-by: kiloconnect[bot] <240665456+kiloconnect[bot]@users.noreply.github.com>
Summary of ChangesHello @jeremylongshore, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request introduces a crucial new troubleshooting document aimed at empowering users to self-diagnose and report issues more effectively. By providing clear guidance on how to access and capture console logs within their respective IDEs, the change significantly improves the support process for Kilo Code, enabling faster identification and resolution of user-reported problems. Highlights
Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
📝 WalkthroughWalkthroughA new troubleshooting guide markdown page is added to the documentation, providing users with step-by-step instructions for capturing console logs, accessing Developer Tools in VS Code and JetBrains, enabling Chrome DevTools, and contacting support with diagnostic information. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Poem
🚥 Pre-merge checks | ✅ 3 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
No actionable comments were generated in the recent review. 🎉 🧹 Recent nitpick comments
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 |
|
Failed to generate code suggestions for PR |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds a helpful troubleshooting guide. The instructions are clear, but I've suggested a significant improvement for the JetBrains section to make it much simpler for users to follow.
Additionally, this new page at /getting-started/troubleshooting is currently not linked from the main navigation or any other documentation pages. To make it discoverable, consider adding it to the 'Help' section in apps/kilocode-docs/lib/nav/getting-started.ts. You might also want to link to it from the troubleshooting sections of other relevant pages, like the installation guide.
| ### Enable JCEF Debugging | ||
|
|
||
| 1. Open your JetBrains IDE and go to **Help → Find Action** (or press `Cmd+Shift+A` / `Ctrl+Shift+A`) | ||
| 2. Type `Registry` and open it | ||
| 3. Search for `jcef` and configure these settings: | ||
| - `ide.browser.jcef.debug.port` → set to `9222` | ||
| - `ide.browser.jcef.contextMenu.devTools.enabled` → check the box | ||
| 4. **Restart your IDE** after making these changes | ||
|
|
||
| ### Connect Chrome DevTools | ||
|
|
||
| 1. Make sure the **Kilo Code panel is open** in your IDE (the debug target won't appear unless the webview is active) | ||
| 2. Open Chrome (or any Chromium-based browser like Edge or Arc) | ||
| 3. Navigate to `http://localhost:9222/json` to see the list of inspectable targets | ||
| 4. Find the entry with `"title": "Kilo Code"` and open the `devtoolsFrontendUrl` link | ||
| 5. Chrome DevTools will open connected to the Kilo webview—click the **Console** tab |
There was a problem hiding this comment.
The instructions for JetBrains can be simplified and made clearer. The current text asks users to enable the DevTools context menu but doesn't explain how to use it, instead providing a more complex manual connection method. The manual method itself can be simplified by using chrome://inspect instead of parsing JSON from a URL.
Here's a revised version that prioritizes the simpler context menu method and provides a clearer fallback.
### Method 1: Use the Context Menu (Recommended)
This requires a one-time setup to enable the menu item.
**1. Enable Context Menu**
1. In your JetBrains IDE, go to **Help → Find Action** (or press `Cmd+Shift+A` / `Ctrl+Shift+A`).
2. Type `Registry` and open it.
3. Find `ide.browser.jcef.contextMenu.devTools.enabled` and check the box.
4. **Restart your IDE**.
**2. Open DevTools**
1. Open the Kilo Code panel.
2. Right-click inside the panel and select **Open DevTools**.
### Method 2: Manual Connection
If the first method fails, you can connect manually:
1. In the `Registry`, set `ide.browser.jcef.debug.port` to `9222` and restart the IDE.
2. With the Kilo Code panel open, navigate to `chrome://inspect` in a Chromium browser.
3. Click **Configure...** and add `localhost:9222`.
4. Click the **inspect** link for the "Kilo Code" target.
jeremylongshore
force-pushed
the
main
branch
from
4231140 to
fa13626
Compare
Review: kilocode Kilo-Org#5865
Checklist
Findings🟡 Page not added to navigationThe troubleshooting page is created at Suggested fix: Add to the "Help" section in {
title: "Help",
links: [
{ href: "/getting-started/faq", children: "FAQ" },
{ href: "/getting-started/troubleshooting", children: "Troubleshooting" },
{
href: "/getting-started/migrating",
children: "Migrating from Cursor",
},
],
},🟡 Maintainer feedback: scope and organization@olearycrew commented that this guide is geared towards the extension and suggested:
This feedback should be addressed before merge. ⚪ JetBrains instructions could be simplerThe JetBrains section asks users to enable
CI Status
Code Snippets# New file: apps/kilocode-docs/pages/getting-started/troubleshooting.md
## Opening Developer Tools
{% tabs %}
{% tab label="VS Code" %}
1. **Open the Command Palette**: Press `Ctrl+Shift+P` (Windows/Linux) or `Cmd+Shift+P` (Mac)
2. **Search for Developer Tools**: Type `Developer: Open Webview Developer Tools` and select it
{% /tab %}
{% tab label="JetBrains" %}
### Enable JCEF Debugging
1. Go to Help → Find Action → Registry
2. Set `ide.browser.jcef.debug.port` → `9222`
3. Enable `ide.browser.jcef.contextMenu.devTools.enabled`
4. Restart IDE
### Connect Chrome DevTools
1. Navigate to `http://localhost:9222/json`
2. Find entry with `"title": "Kilo Code"`, open `devtoolsFrontendUrl`
{% /tab %}
{% /tabs %}VerdictCOMMENT - Well-written troubleshooting guide with good Markdoc tabs usage. Two items need attention before merge: (1) the page must be added to the nav config in |
Review Journal: kilocode Kilo-Org#5865
SummaryA new troubleshooting guide for capturing console logs in VS Code and JetBrains IDEs. Well-written content with proper Markdoc tab components, but the page isn't connected to the site navigation and maintainer @olearycrew has unaddressed feedback about scope and organization. Needs nav integration and maintainer alignment before merge. First ImpressionsTitle "Add troubleshooting with console capture" signals a practical support doc. At 58 lines in a single new file, this is a clean addition — no existing code modified. The PR description is minimal ("let me know if you have any thoughts/feedback"), suggesting early-stage content seeking review. What I Looked At
AnalysisContent quality is solidThe guide covers two IDEs with appropriate tabs: VS Code (3 steps): Command Palette → Developer: Open Webview Developer Tools → Console tab. Straightforward and accurate. JetBrains (2 sections):
The "Capturing the Error" section and "Contact Support" section are clean and actionable. Missing navigation integrationThe page is created but { href: "/getting-started/faq", children: "FAQ" },
{ href: "/getting-started/migrating", children: "Migrating from Cursor" },A Maintainer feedback not yet addressed@olearycrew commented:
Two requests:
JetBrains UX could be simplerThe instructions enable the context menu DevTools (
VerificationAll CI checks pass (this is the first external-contributor PR where Vercel also passed): Bot Review Synthesis
Greptile investigation needed: Greptile has not commented on any of our 4 fork PRs despite being installed and configured with a detailed Lessons Learned1. New pages need nav integration. Creating a page without updating the nav config is a common oversight in docs PRs. This should be a standard checklist item: "If adding a new page, is it linked from the nav?" 2. Maintainer feedback is part of the review. @olearycrew's comments on scope and folder organization represent design decisions that should be resolved before a code review can give a final verdict. Our review acknowledges and surfaces this feedback. 3. Vercel deploys for some external contributors. Unlike PR Kilo-Org#5667 where Vercel skipped, this PR's author (@alexkgold) has auth to trigger Vercel deploys. This means they likely have org access — different from truly external contributors. 4. Greptile remains non-functional. 0/4 PRs reviewed despite proper config. This needs to be resolved for the tool to earn its $20/month. All the value so far comes from CodeRabbit (free) and Gemini (free). Review #4 of 75 | Review methodology: AI PR Review Case Studies | Reviewed with GWI + Claude Code |
2 participants
Mirror of Kilo-Org#5865
This PR mirrors the upstream change for multi-AI review analysis.
Changes
Adds a new troubleshooting page with instructions for capturing console logs in VS Code and JetBrains IDEs. Includes Developer Tools opening, JCEF debugging for JetBrains, and contact support info.
Bot Review Checklist
Summary by CodeRabbit