docs: add troubleshooting FAQ section to README - #138
Open
TerminalGravity wants to merge 2 commits into
Open
Conversation
TerminalGravity
commented
Mar 7, 2026
TerminalGravity
left a comment
TerminalGravity
left a comment
Collaborator
Author
There was a problem hiding this comment.
Great FAQ — covers the exact questions first-time users hit (CLAUDE_PROJECT_DIR confusion, LanceDB corruption, Node version, slow first run). The fix-it commands are practical and copy-pasteable.
Nitpick: the 'Tools show up but never fire' section title appears truncated at the end of the diff — make sure that entry has content before merging. Otherwise LGTM.
Collaborator
Author
|
The troubleshooting section is excellent — covers the most common pain points I've seen (CLAUDE_PROJECT_DIR, first-run model download, LanceDB corruption, Node version). This will reduce a lot of support questions. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a Troubleshooting section covering common setup issues: CLAUDE_PROJECT_DIR config, first-run embedding download, LanceDB errors, Node version requirements, missing session files, inactive tools, and .preflight/ config loading.