Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
e9e8cff
Add troubleshooting with console capture
alexkgold Feb 13, 2026
36ad8d2
Update apps/kilocode-docs/pages/getting-started/troubleshooting.md
alexkgold Feb 13, 2026
3d134dc
Update apps/kilocode-docs/pages/getting-started/troubleshooting.md
alexkgold Feb 13, 2026
631be09
Create troubleshooting section
alexkgold Feb 16, 2026
4169383
Merge branch 'docs/troubleshooting' of https://github.com/kilo-org/ki…
alexkgold Feb 16, 2026
d3fce69
Update apps/kilocode-docs/pages/troubleshooting/troubleshooting-exten…
alexkgold Feb 16, 2026
cbf96af
Update apps/kilocode-docs/pages/troubleshooting/troubleshooting-exten…
alexkgold Feb 16, 2026
27416f0
Update apps/kilocode-docs/pages/troubleshooting/troubleshooting-exten…
alexkgold Feb 16, 2026
e59ab2f
Update apps/kilocode-docs/AGENTS.md
alexkgold Feb 16, 2026
ec68a59
Apply suggestion from @alexkgold
alexkgold Feb 16, 2026
812a0a2
Apply suggestion from @alexkgold
alexkgold Feb 16, 2026
2178cf0
Update apps/kilocode-docs/pages/troubleshooting/index.md
alexkgold Feb 16, 2026
4dceb22
Move troubleshooting under help nav
alexkgold Feb 16, 2026
6cf499b
Update apps/kilocode-docs/package.json
alexkgold Feb 17, 2026
02c1b1a
Clean up troubleshooting rom top-level nav
alexkgold Feb 17, 2026
ba66108
Update apps/kilocode-docs/AGENTS.md
alexkgold Feb 17, 2026
ea01e16
Update apps/kilocode-docs/pages/getting-started/troubleshooting/troub…
alexkgold Feb 17, 2026
3aacc6e
Update apps/kilocode-docs/pages/getting-started/troubleshooting/index.md
alexkgold Feb 17, 2026
6c8c117
Merge branch 'main' into docs/troubleshooting
alexkgold Feb 17, 2026
17f2437
Apply suggestion from @alexkgold
alexkgold Feb 17, 2026
8fa46cd
Apply suggestion from @alexkgold
alexkgold Feb 17, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
116 changes: 50 additions & 66 deletions apps/kilocode-docs/AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,91 +20,75 @@ This convention helps identify documentation-only PRs and keeps them organized.

This project uses [Markdoc](https://markdoc.dev/) for rendering markdown with custom components. Custom tags allow you to embed React components directly in markdown files.

## Converting from old documentation site

This site was previously in docusaurus but is now in markdoc. Sometimes the user may ask you to update the images and other tags in a page that was imported. These are the types of updates you'd need to make

### Images

Images will often look like standard HTML image tags like:
Use the Markdoc image tag format:

<img src="/docs/img/kilo-provider/connected-accounts.png" alt="Connect account screen" width="600" />
```markdown
{% image src="/docs/img/kilo-provider/connected-accounts.png" alt="Connect account screen" width="800" caption="Connect account screen" /%}
```

We want to convert them to Markdoc image tags like this:
Note that this site is served under kilo.ai/docs so the `/docs` prefix **must** be present in every image path.

{% image src="/docs/img/kilo-provider/connected-accounts.png" alt="Connect account screen" width="800" caption="Connect account screen" /%}
Image attributes:

Note that this site is served under kilo.ai/docs so the `/docs` MUST be present in every image tag.

Image attributes

```json
src: {
type: String,
required: true,
description: "The image source URL",
},
alt: {
type: String,
required: true,
description: "Alternative text for the image",
},
width: {
type: String,
description: "Width of the image (e.g., '500px', '80%')",
},
height: {
type: String,
description: "Height of the image (e.g., '300px', 'auto')",
},
caption: {
type: String,
description: "Optional caption displayed below the image",
}
```
| Attribute | Type | Required | Description |
| --------- | ------ | -------- | ------------------------------------------- |
| `src` | String | Yes | The image source URL |
| `alt` | String | Yes | Alternative text for the image |
| `width` | String | No | Width of the image (e.g., '500px', '80%') |
| `height` | String | No | Height of the image (e.g., '300px', 'auto') |
| `caption` | String | No | Caption displayed below the image |

### Callouts

When callouts are used, they should be in markdoc format like this:
Use the Markdoc callout tag format:

```markdown
{% callout type="info" %}
You can report any bugs or feedbacks by chatting with us in our [Discord server](https://discord.gg/ovhcloud), in the AI Endpoints channel.
You can report any bugs or feedback by chatting with us in our [Discord server](https://discord.gg/ovhcloud), in the AI Endpoints channel.
{% /callout %}
```

Callout Attributes:

```json
title: {
type: String,
description: "Optional custom title for the callout",
},
type: {
type: String,
default: "note",
matches: ["generic", "note", "tip", "info", "warning", "danger"],
description:
"The type of callout: generic (no icon/title), note, tip, info, warning, or danger",
},
collapsed: {
type: Boolean,
default: false,
description:
"When true, the callout starts collapsed and can be expanded by clicking the header",
}
```
Callout attributes:

### Codicons
| Attribute | Type | Default | Description |
| ----------- | ------- | ------- | ------------------------------------------------- |
| `title` | String | - | Optional custom title for the callout |
| `type` | String | "note" | One of: generic, note, tip, info, warning, danger |
| `collapsed` | Boolean | false | When true, the callout starts collapsed |

Codicon icons look like this:

```html
<Codicon name="gear" />
```
### Codicons

And we want to convert that to look like this:
Use the Markdoc codicon tag format:

```markdown
{% codicon name="gear" /%}
```

## Documentation Guidelines

### Adding New Pages

1. Create your page in the appropriate directory under `pages/`
2. **Always update navigation**: Add the page to the corresponding navigation file in `lib/nav/`
- Each section has its own nav file (e.g., `getting-started.ts`, `code-with-ai.ts`, `ai-providers.ts`)
- Navigation structure is exported from `lib/nav/index.ts`
- See `lib/types.ts` for the `NavSection` and `NavLink` interfaces

### Removing or Moving Pages

**Never remove a page without adding a redirect.** This prevents broken links from search engines, external references, and user bookmarks.

1. Add a redirect entry to `previous-docs-redirects.js`
2. Redirect format:
```javascript
{
source: "/docs/old-path",
destination: "/docs/new-path",
basePath: false,
permanent: true,
}
```
3. Update the navigation file to remove or update the link
4. Redirects are loaded in `next.config.js`
10 changes: 10 additions & 0 deletions apps/kilocode-docs/lib/nav/getting-started.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,16 @@ export const GettingStartedNav: NavSection[] = [
href: "/getting-started/migrating",
children: "Migrating from Cursor",
},
{
href: "/getting-started/troubleshooting",
children: "Troubleshooting",
subLinks: [
{
href: "/getting-started/troubleshooting/troubleshooting-extension",
children: "Extension Troubleshooting",
},
],
},
],
},
]
12 changes: 12 additions & 0 deletions apps/kilocode-docs/pages/getting-started/troubleshooting/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: "Troubleshooting"
description: "Guides for diagnosing and resolving issues with Kilo Code"
---

# Troubleshooting

This section contains guides for diagnosing and resolving common issues with Kilo Code.

## Guides

- [**Extension Troubleshooting**](/docs/getting-started/troubleshooting/troubleshooting-extension) - How to capture console logs and report issues with the Kilo Code extension
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
title: "Troubleshooting IDE Extensions"
description: "How to capture console logs and report issues with Kilo Code"
---

# Capturing Console Logs

Providing console logs helps us pinpoint exactly what's going wrong with your installation, network, or MCP setup. This guide walks you through capturing those logs in your IDE.

## 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. 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
Comment thread
alexkgold marked this conversation as resolved.
5. Chrome DevTools will open connected to the Kilo webview—click the **Console** tab

{% /tab %}
{% /tabs %}

## Capturing the Error

Once you have the Developer Tools console open:

1. **Clear previous logs**: Click the "Clear Console" button (🚫 icon at the top of the Console panel) to remove old messages
2. **Reproduce the issue**: Perform the action that was causing problems
3. **Check for errors**: Look at the Console tab for error messages (usually shown in red). If you suspect connection issues, also check the **Network** tab
4. **Copy the logs**: Right-click in the console and select "Save as..." or copy the relevant error messages

## Contact Support

If you're unable to resolve the issue, please inspect the console logs, remove any secrets, and send the logs to **[hi@kilocode.ai](mailto:hi@kilocode.ai)** along with the following:

- The error messages from the console
- Steps to reproduce the issue
Comment thread
alexkgold marked this conversation as resolved.
- Screenshots or screen recordings of the issue
- Your IDE and Kilo Code version
Loading