docs: add TROUBLESHOOTING.md with common setup and usage fixes#177
docs: add TROUBLESHOOTING.md with common setup and usage fixes#177TerminalGravity wants to merge 2 commits intomainfrom
Conversation
- examples/.preflight/config.yml — main config with inline docs - examples/.preflight/triage.yml — triage rules with keyword examples - examples/.preflight/contracts/api.yml — sample contract definitions - examples/.preflight/README.md — getting started guide - README.md — link to examples from config section
TerminalGravity
left a comment
TerminalGravity
left a comment
There was a problem hiding this comment.
TROUBLESHOOTING.md looks solid — covers the right pain points (Node version, CLAUDE_PROJECT_DIR, LanceDB native deps, embeddings config). A few notes:
-
Same branch overlap issue — this also includes examples/.preflight/ files that belong in #174. Once #174 lands, rebase this to just the TROUBLESHOOTING.md + README link.
-
The troubleshooting content itself is good. One suggestion: add a section on "MCP server won't connect" — that's probably the #1 thing people will hit (stdio path issues, permissions, Claude Desktop config syntax).
-
Minor: the README additions look clean. The link placement makes sense.
Approve once the #174 overlap is cleaned up.
TerminalGravity
left a comment
TerminalGravity
left a comment
There was a problem hiding this comment.
TROUBLESHOOTING.md is thorough — covers the right pain points (LanceDB native deps, CLAUDE_PROJECT_DIR, config loading, token usage). README links are clean. LGTM.
1 participant
Adds a comprehensive troubleshooting guide covering:
Also adds a Troubleshooting section link in README.