Skip to content

Add troubleshooting with console capture#5865

Merged
alexkgold merged 21 commits intomainfrom
docs/troubleshooting
Feb 17, 2026
Merged

Add troubleshooting with console capture#5865
alexkgold merged 21 commits intomainfrom
docs/troubleshooting

Conversation

@alexkgold
Copy link
Copy Markdown
Contributor

@LigiaZ -- let me know if you have any thoguhts/feedback
@olearycrew -- is this the right place?

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Feb 13, 2026

⚠️ No Changeset found

Latest commit: 8fa46cd

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel vercel Bot temporarily deployed to docs-staging – docs February 13, 2026 16:53 Inactive
Comment thread apps/kilocode-docs/pages/getting-started/troubleshooting.md Outdated
@vercel vercel Bot temporarily deployed to docs-staging – docs February 13, 2026 17:03 Inactive
@kilo-code-bot
Copy link
Copy Markdown
Contributor

kilo-code-bot Bot commented Feb 13, 2026

Code Review Summary

Status: No New Issues Found | Recommendation: Address existing comments before merge

Overview

This PR adds a troubleshooting section to the Kilo Code documentation under getting-started/troubleshooting/, including a guide for capturing console logs in VS Code and JetBrains IDEs. It also cleans up AGENTS.md by reformatting attribute documentation into tables and adding guidelines for adding/removing pages.

Previous review rounds have already identified the key issues — no additional problems found in this pass.

Previously Flagged Issues (from other reviewers)

Severity Count
WARNING 3
SUGGESTION ~10

Key items still worth addressing:

  • Broken link in index.md line 12 — uses /docs/ prefix which may not resolve correctly for internal Markdoc links
  • Run-on sentence in troubleshooting-extension.md line 53 — ambiguous pronoun "them"
  • devtoolsFrontendUrl caveat in line 35 — may be a relative path, needs clarification for users
Files Reviewed (4 files)
  • apps/kilocode-docs/AGENTS.md - 0 new issues (reformatted attribute docs, added page guidelines)
  • apps/kilocode-docs/lib/nav/getting-started.ts - 0 new issues (added troubleshooting nav entry)
  • apps/kilocode-docs/pages/getting-started/troubleshooting/index.md - 0 new issues (new file)
  • apps/kilocode-docs/pages/getting-started/troubleshooting/troubleshooting-extension.md - 0 new issues (new file)

Co-authored-by: kiloconnect[bot] <240665456+kiloconnect[bot]@users.noreply.github.com>
@alexkgold alexkgold requested a review from LigiaZ February 13, 2026 17:16
@vercel vercel Bot temporarily deployed to docs-staging – docs February 13, 2026 17:18 Inactive
@olearycrew
Copy link
Copy Markdown
Contributor

Seems like this is geared towards the extension so maybe make that clear / organize a troubleshooting folder with just one in it for now for the extension.

Comment thread apps/kilocode-docs/pages/troubleshooting/troubleshooting-extension.md Outdated
@kevinvandijk kevinvandijk added the documentation Improvements or additions to documentation label Feb 13, 2026
@jeremylongshore
Copy link
Copy Markdown

Review: kilocode #5865

Add troubleshooting with console capture by @alexkgold
Multi-AI analysis: Fork PR #7 — reviewed by CodeRabbit, Gemini, CodeQL, Qodo

Checklist

Check Result Notes
Correctness PASS VS Code command and JetBrains JCEF steps are accurate
Conventions ISSUE Page not added to navigation (getting-started.ts)
Changeset SKIP Docs-only PR, no version bump required
Tests N/A No code changes
i18n N/A Docs site, not UI strings
Types N/A No TypeScript
Security N/A Static documentation
Scope PASS Single file, single concern

Findings

🟡 Page not added to navigation

The troubleshooting page is created at getting-started/troubleshooting.md but is not added to apps/kilocode-docs/lib/nav/getting-started.ts. The page won't appear in the sidebar and users can only find it via direct URL or search.

Suggested fix: Add to the "Help" section in getting-started.ts:

{
    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:

  1. Making that scope explicit in the content
  2. Organizing into a troubleshooting folder (e.g., getting-started/troubleshooting/index.md)

This feedback should be addressed before merge.

⚪ JetBrains instructions could be simpler

The JetBrains section asks users to enable ide.browser.jcef.contextMenu.devTools.enabled but then doesn't explain how to use the context menu. Instead it directs them to manually connect via localhost:9222/json and parse JSON. Consider:

  1. Adding a "right-click → Inspect" instruction after enabling the context menu
  2. Using chrome://inspect as an alternative to the JSON endpoint

CI Status

Check Result
Build Markdoc Site PASS
compile PASS
check-translations PASS
unit-test PASS
test-extension (ubuntu) PASS
test-extension (windows) PASS
test-webview (ubuntu) PASS
test-webview (windows) PASS
build-cli PASS
test-cli PASS
test-jetbrains PASS
Vercel PASS

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 %}

Verdict

COMMENT - 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 getting-started.ts for discoverability, and (2) @olearycrew's feedback about scoping to the extension and folder organization should be addressed. The JetBrains instructions could also be simplified. Content accuracy is solid.

@jeremylongshore
Copy link
Copy Markdown

jeremylongshore commented Feb 14, 2026

Review Journal: kilocode #5865

PR: #5865 |
Title: Add troubleshooting with console capture |
Author: @alexkgold |
Category: docs | Tier: 1 | Size: 58 lines, 1 file | Confidence: 4/5

Multi-AI analysis: Fork PR #7 — CodeRabbit, Gemini, CodeQL, Qodo


Summary

A 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 Impressions

Title "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

  1. The new filegetting-started/troubleshooting.md (58 lines, Markdoc with tabs)
  2. Navigation configapps/kilocode-docs/lib/nav/getting-started.ts to check if page is linked
  3. Existing troubleshooting references — 20+ files mention "troubleshooting" but no dedicated page exists yet
  4. Upstream PR comments@olearycrew and kiloconnect bot feedback
  5. Fork PR Add discord link and binary name to readme #7 — Gemini and CodeRabbit bot reviews
  6. All upstream CI checks — 12/12 pass (including Vercel)

Analysis

Content quality is solid

The 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):

  1. Enable JCEF Debugging via Registry settings (ide.browser.jcef.debug.port → 9222, ide.browser.jcef.contextMenu.devTools.enabled)
  2. Connect Chrome DevTools via localhost:9222/json, find Kilo Code target, open devtoolsFrontendUrl

The "Capturing the Error" section and "Contact Support" section are clean and actionable.

Missing navigation integration

The page is created but getting-started.ts doesn't reference it. The "Help" section currently has:

{ href: "/getting-started/faq", children: "FAQ" },
{ href: "/getting-started/migrating", children: "Migrating from Cursor" },

A Troubleshooting entry would naturally fit between FAQ and Migrating. Without it, users can only reach this page via direct URL or site search.

Maintainer feedback not yet addressed

@olearycrew commented:

"Seems like this is geared towards the extension so maybe make that clear / organize a troubleshooting folder with just one in it for now for the extension."

Two requests:

  1. Scope clarity — The guide applies to the VS Code extension and JetBrains plugin but doesn't say "extension" in the title or intro
  2. Folder organization — Suggests getting-started/troubleshooting/ as a folder (with index.md for the extension guide), anticipating future troubleshooting pages (e.g., CLI troubleshooting)

JetBrains UX could be simpler

The instructions enable the context menu DevTools (ide.browser.jcef.contextMenu.devTools.enabled) but then don't explain how to use it (right-click → Inspect). Instead they direct users to manually navigate to localhost:9222/json and parse JSON. Two improvements:

  1. Primary method: right-click in Kilo Code panel → Open DevTools (after enabling)
  2. Fallback: chrome://inspect is simpler than parsing localhost:9222/json

Verification

All CI checks pass (this is the first external-contributor PR where Vercel also passed):

Build Markdoc Site     PASS    (directly relevant - docs build)
check-translations     PASS    (directly relevant - no broken strings)
compile                PASS
test-extension         PASS    (ubuntu + windows)
test-webview           PASS    (ubuntu + windows)
unit-test              PASS
build-cli              PASS
test-cli               PASS
test-jetbrains         PASS
Vercel                 PASS    (deployed preview)

Bot Review Synthesis

Bot Verdict Key Finding Useful?
Gemini Comment Missing nav entry; JetBrains instructions can be simpler (chrome://inspect) Yes — caught both issues
CodeRabbit Processing Still generating review at time of submission Pending
Greptile No response Has not responded on any fork PR (0/4) Non-functional — needs investigation
CodeQL N/A No security findings (docs-only) Expected
Qodo Failed "Failed to generate code suggestions" Config issue persists

Greptile investigation needed: Greptile has not commented on any of our 4 fork PRs despite being installed and configured with a detailed greptile.json. Possible causes: codebase indexing incomplete for the fork, docs-only changes filtered out, or plan/rate limits. Will investigate via Greptile dashboard.

Lessons Learned

1. 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 #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

jeremylongshore added a commit to jeremylongshore/kilocode that referenced this pull request Feb 15, 2026
Mirror: Add troubleshooting with console capture (Kilo-Org#5865)
Copy link
Copy Markdown
Contributor

@olearycrew olearycrew left a comment

Choose a reason for hiding this comment

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

@alexkgold approved but see my note

@vercel vercel Bot temporarily deployed to docs-staging – docs February 16, 2026 22:13 Inactive
Comment thread apps/kilocode-docs/pages/troubleshooting/troubleshooting-extension.md Outdated
Comment thread apps/kilocode-docs/pages/troubleshooting/troubleshooting-extension.md Outdated
@vercel vercel Bot temporarily deployed to docs-staging – docs February 16, 2026 22:15 Inactive
Comment thread apps/kilocode-docs/pages/troubleshooting/troubleshooting-extension.md Outdated
Comment thread apps/kilocode-docs/AGENTS.md Outdated
Comment thread apps/kilocode-docs/pages/troubleshooting/troubleshooting-extension.md Outdated
Comment thread apps/kilocode-docs/pages/troubleshooting/index.md Outdated
@vercel vercel Bot temporarily deployed to docs-staging – docs February 16, 2026 22:46 Inactive
Co-authored-by: kiloconnect[bot] <240665456+kiloconnect[bot]@users.noreply.github.com>
@vercel vercel Bot temporarily deployed to docs-staging – docs February 16, 2026 22:55 Inactive
Comment thread apps/kilocode-docs/pages/getting-started/troubleshooting/index.md Outdated
Comment thread apps/kilocode-docs/lib/nav/troubleshooting.ts Outdated
Comment thread apps/kilocode-docs/package.json Outdated
@vercel vercel Bot temporarily deployed to docs-staging – docs February 16, 2026 23:06 Inactive
@vercel vercel Bot temporarily deployed to docs-staging – docs February 17, 2026 16:06 Inactive
Comment thread apps/kilocode-docs/AGENTS.md Outdated
@vercel vercel Bot temporarily deployed to docs-staging – docs February 17, 2026 16:11 Inactive
alexkgold and others added 4 commits February 17, 2026 11:26
Co-authored-by: kiloconnect[bot] <240665456+kiloconnect[bot]@users.noreply.github.com>
…leshooting-extension.md

Co-authored-by: kiloconnect[bot] <240665456+kiloconnect[bot]@users.noreply.github.com>
Co-authored-by: kiloconnect[bot] <240665456+kiloconnect[bot]@users.noreply.github.com>
@alexkgold alexkgold enabled auto-merge February 17, 2026 16:29
@vercel vercel Bot temporarily deployed to docs-staging – docs February 17, 2026 16:31 Inactive
Comment thread apps/kilocode-docs/components/TopNav.tsx Outdated
Comment thread apps/kilocode-docs/package.json Outdated
@vercel vercel Bot temporarily deployed to docs-staging – docs February 17, 2026 16:53 Inactive
@alexkgold alexkgold merged commit 2561c84 into main Feb 17, 2026
11 checks passed
@alexkgold alexkgold deleted the docs/troubleshooting branch February 17, 2026 16:59
j-Guru pushed a commit to j-Guru/kilocode that referenced this pull request Feb 23, 2026
Add troubleshooting with console capture
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants