Skip to content

docs: add troubleshooting section to README - #84

Closed
TerminalGravity wants to merge 1 commit into
mainfrom
docs/troubleshooting-section
Closed

docs: add troubleshooting section to README#84
TerminalGravity wants to merge 1 commit into
mainfrom
docs/troubleshooting-section

Conversation

@TerminalGravity

Copy link
Copy Markdown
Collaborator

Adds a Troubleshooting section covering 6 common issues users hit:

  • LanceDB native module errors
  • First-run embedding model download stalling
  • 'No session data found' / timeline search empty
  • .preflight/ config not loading
  • Tools not appearing in Claude Code
  • Permission errors on ~/.preflight/

No code changes — README only.

Covers common issues: LanceDB native modules, first-run model download,
missing session data, .preflight/ config not loading, tools not appearing
in Claude Code, and permission errors.
@TerminalGravity

Copy link
Copy Markdown
Collaborator Author

Troubleshooting section looks great — covers the common gotchas (embedding provider config, sharp install, permission issues). CI still running on node 20 but 22 already passed. Once green, this is good to go.

@TerminalGravity

Copy link
Copy Markdown
Collaborator Author

These are exactly the questions people hit. The LanceDB and CLAUDE_PROJECT_DIR sections will save a lot of confusion. Minor: could mention approximate download time (~30-60s) in the slow first run section. Merging.

@TerminalGravity TerminalGravity left a comment

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Clean troubleshooting section. Covers the common stumbling blocks. ✅

@TerminalGravity

Copy link
Copy Markdown
Collaborator Author

Superseded by #118/#114.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant