Skip to content

Commit fe96e18

Browse files
committed
docs: add troubleshooting guide to website
- Add concise troubleshooting page with quick fixes - Cover installation, indexing, MCP, search, and GitHub issues - Link to full TROUBLESHOOTING.md for detailed solutions - Update navigation to include troubleshooting
1 parent 0b2fbb3 commit fe96e18

File tree

3 files changed

+163
-1
lines changed

3 files changed

+163
-1
lines changed

PLAN.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ Focus on quality, documentation, and developer experience before adding new feat
136136
|------|--------|----------|
137137
| CLI reference docs | ✅ Done | 🟡 Medium |
138138
| Configuration guide | ✅ Done | 🟡 Medium |
139-
| Troubleshooting guide | 🔲 Todo | 🟡 Medium |
139+
| Troubleshooting guide | ✅ Done | 🟡 Medium |
140140
| Examples for new tools | 🔲 Todo | 🟢 Low |
141141

142142
### Code Quality

website/content/docs/_meta.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ export default {
44
quickstart: 'Quickstart',
55
cli: 'CLI Reference',
66
configuration: 'Configuration',
7+
troubleshooting: 'Troubleshooting',
78
'---tools': {
89
type: 'separator',
910
title: 'MCP Tools',
Lines changed: 161 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,161 @@
1+
# Troubleshooting
2+
3+
Quick solutions for common issues. For detailed troubleshooting, see the [full guide on GitHub](https://github.com/lytics/dev-agent/blob/main/TROUBLESHOOTING.md).
4+
5+
## Installation Issues
6+
7+
### `dev: command not found`
8+
9+
Global npm bin directory not in PATH:
10+
11+
```bash
12+
# Find npm bin directory
13+
npm config get prefix
14+
15+
# Add to shell profile (~/.zshrc or ~/.bashrc)
16+
export PATH="$(npm config get prefix)/bin:$PATH"
17+
18+
# Reload
19+
source ~/.zshrc
20+
```
21+
22+
### Permission errors on install
23+
24+
```bash
25+
# Option 1: Use npx (no install needed)
26+
npx dev-agent index .
27+
28+
# Option 2: Fix npm permissions
29+
npm config set prefix ~/.npm-global
30+
export PATH=~/.npm-global/bin:$PATH
31+
npm install -g dev-agent
32+
```
33+
34+
## Indexing Issues
35+
36+
### "No source files found"
37+
38+
```bash
39+
# Verify you're in repository root
40+
ls -la # Should see .git/
41+
42+
# Check for supported files
43+
find . -name "*.ts" -o -name "*.js" | head -10
44+
```
45+
46+
### "Vector storage initialization failed"
47+
48+
```bash
49+
# Check permissions
50+
ls -la ~/.dev-agent/
51+
52+
# Clear and rebuild
53+
rm -rf ~/.dev-agent/indexes/*
54+
dev index .
55+
```
56+
57+
## MCP Server Issues
58+
59+
### Server won't start
60+
61+
```bash
62+
# 1. Check if indexed
63+
ls -la ~/.dev-agent/indexes/
64+
65+
# 2. Verify installation
66+
dev mcp list --cursor # or without --cursor
67+
68+
# 3. Test manually
69+
dev mcp start --verbose
70+
```
71+
72+
### "Repository not indexed" in Cursor
73+
74+
```bash
75+
# Index the workspace
76+
dev index .
77+
78+
# Restart Cursor
79+
```
80+
81+
### Rate limit errors (429)
82+
83+
- Wait for `retryAfterMs` period
84+
- Check health: `dev_health`
85+
- Restart AI tool if persistent
86+
87+
## Search Issues
88+
89+
### No results
90+
91+
```bash
92+
# Verify indexed
93+
dev stats
94+
95+
# Re-index if needed
96+
dev index .
97+
```
98+
99+
**Tips for better searches:**
100+
- Use natural language, not exact code
101+
- Describe what code does
102+
- Try different phrasings
103+
104+
### Poor relevance
105+
106+
Adjust score threshold:
107+
- `0.7+` — Precise matches only
108+
- `0.4-0.6` — Balanced
109+
- `0.25-0.3` — Exploratory
110+
111+
## GitHub Integration
112+
113+
### `dev gh index` fails
114+
115+
```bash
116+
# Check GitHub CLI
117+
gh auth status
118+
119+
# Login if needed
120+
gh auth login
121+
```
122+
123+
### Stale GitHub data
124+
125+
```bash
126+
dev gh index # Re-index
127+
```
128+
129+
## Quick Fixes
130+
131+
### Clear everything and start fresh
132+
133+
```bash
134+
rm -rf ~/.dev-agent/indexes/*
135+
dev index .
136+
dev gh index
137+
dev mcp install --cursor
138+
```
139+
140+
### Check health
141+
142+
```
143+
Use dev_health tool in Cursor/Claude Code
144+
```
145+
146+
### Enable debug logging
147+
148+
**Cursor:** Edit `~/.cursor/mcp.json`:
149+
```json
150+
"env": { "LOG_LEVEL": "debug" }
151+
```
152+
153+
## Getting Help
154+
155+
1. Run `dev_health` for diagnostics
156+
2. Check [full troubleshooting guide](https://github.com/lytics/dev-agent/blob/main/TROUBLESHOOTING.md)
157+
3. [File an issue](https://github.com/lytics/dev-agent/issues) with:
158+
- `dev --version`
159+
- `dev_health` output
160+
- Steps to reproduce
161+

0 commit comments

Comments
 (0)