create a troubleshoot section to the docs website (#1805)
* add some helpful information to the troubleshooting section of the documentation website I was having an issue with vibe-kanban recently and I had to do a lot of digging myself in order to debug the issue. It would be helpful to have a troubleshooting section of the website that lists some basic tips for how to fix issues on your own. * make warning stronger --------- Co-authored-by: Gabriel Gordon-Hall <ggordonhall@gmail.com>
This commit is contained in:
@@ -80,6 +80,12 @@
|
||||
"integrations/mcp-server-configuration",
|
||||
"integrations/vibe-kanban-mcp-server"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Help",
|
||||
"pages": [
|
||||
"troubleshooting"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
|
||||
64
docs/troubleshooting.mdx
Normal file
64
docs/troubleshooting.mdx
Normal file
@@ -0,0 +1,64 @@
|
||||
---
|
||||
title: "Troubleshooting"
|
||||
description: "Common issues and solutions when using Vibe Kanban"
|
||||
---
|
||||
|
||||
## Agent Reports Empty Codebase
|
||||
|
||||
If your coding agent reports that the codebase is empty when you create a new task, you may have Git's sparse-checkout feature enabled in your repository.
|
||||
|
||||
**Solution:**
|
||||
|
||||
Run the following command in the root directory of your repository:
|
||||
|
||||
```bash
|
||||
git sparse-checkout disable
|
||||
```
|
||||
|
||||
After disabling sparse-checkout, create a new task and try again.
|
||||
|
||||
## Enabling Debug Logs
|
||||
|
||||
If you need more detailed logs to help debug an issue, you can enable debug-level logging by setting the `RUST_LOG` environment variable.
|
||||
|
||||
**Usage:**
|
||||
|
||||
```bash
|
||||
RUST_LOG=debug npx vibe-kanban
|
||||
```
|
||||
|
||||
This will provide verbose logging output that can help identify the root cause of issues.
|
||||
|
||||
## DANGER: Wiping Your Database
|
||||
|
||||
If you encounter irrecoverable errors and need to completely wipe your Vibe Kanban database, you can delete the application data directory for your operating system.
|
||||
|
||||
<Warning>
|
||||
This action is irreversible and will result in the loss of ALL your tasks and settings. Make sure to back up any important information before proceeding.
|
||||
</Warning>
|
||||
|
||||
**Delete the following directory based on your OS:**
|
||||
|
||||
<Tabs>
|
||||
<Tab title="macOS">
|
||||
```bash
|
||||
~/Library/Application Support/ai.bloop.vibe-kanban/
|
||||
```
|
||||
</Tab>
|
||||
|
||||
<Tab title="Linux">
|
||||
```bash
|
||||
~/.local/share/vibe-kanban/
|
||||
```
|
||||
</Tab>
|
||||
|
||||
<Tab title="Windows">
|
||||
```
|
||||
%APPDATA%\bloop\vibe-kanban\
|
||||
```
|
||||
|
||||
Typically: `C:\Users\<username>\AppData\Roaming\bloop\vibe-kanban\`
|
||||
</Tab>
|
||||
</Tabs>
|
||||
|
||||
After deleting the application data directory, restart Vibe Kanban to reset with an empty database and default settings.
|
||||
Reference in New Issue
Block a user