-
Notifications
You must be signed in to change notification settings - Fork 19
Labels
MVPKiller feature sprintKiller feature sprintdocumentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomers
Description
Problem
Users hit errors and don't know what they mean or how to fix them.
Solution
Create docs/TROUBLESHOOTING.md with common errors:
Content Needed
API Errors
| Error | Cause | Fix |
|---|---|---|
ANTHROPIC_API_KEY not set |
No API key configured | Run export ANTHROPIC_API_KEY=sk-... or cortex wizard |
Rate limit exceeded |
Too many requests | Wait 60 seconds or use --offline |
Invalid API key |
Key expired or wrong | Get new key from console.anthropic.com |
System Errors
| Error | Cause | Fix |
|---|---|---|
apt lock held |
Another process using apt | sudo killall apt apt-get or wait |
Permission denied |
Need sudo | Run with sudo cortex install X |
Package not found |
Typo or not in repos | Check spelling, try cortex search X |
Network Errors
| Error | Cause | Fix |
|---|---|---|
Connection timeout |
Network issue | Check internet, try --offline |
SSL certificate error |
Corporate proxy | Set HTTP_PROXY env var |
Acceptance Criteria
- Create docs/TROUBLESHOOTING.md
- Cover top 15 error scenarios
- Plain English explanations
- Copy-paste fix commands
- Link from main README
## Bounty: $15 now (+$15 match after funding)
Total: $30 when we close our funding round.
Metadata
Metadata
Assignees
Labels
MVPKiller feature sprintKiller feature sprintdocumentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomers