Skip to content

docs: add TROUBLESHOOTING.md#227

Open
TerminalGravity wants to merge 3 commits intomainfrom
docs/troubleshooting
Open

docs: add TROUBLESHOOTING.md#227
TerminalGravity wants to merge 3 commits intomainfrom
docs/troubleshooting

Conversation

@TerminalGravity
Copy link
Collaborator

Adds a comprehensive troubleshooting guide covering:

  • LanceDB native module errors
  • Embedding model download issues
  • npx version/cache problems
  • MCP server connection debugging
  • .preflight/ config detection
  • Semantic search indexing
  • Memory usage

Also links it from README.md.

Copy link
Collaborator Author

@TerminalGravity TerminalGravity left a comment

Choose a reason for hiding this comment

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

Solid troubleshooting guide — covers the main pain points I'd expect from setup. The LanceDB native module section is especially useful since that trips up a lot of people on different architectures.

Two suggestions:

  1. Add a Node version compatibility note — preflight requires Node 18+, and a surprising number of people still run 16. Worth a quick "Check your Node version" section at the top since it affects everything downstream.

  2. The npx cache section could mention npx -y preflight-dev-serve@latest to force the latest version — I've seen people get stuck on stale cached versions and not realize -y alone doesn't bust the cache.

Otherwise LGTM — this will save a lot of GitHub issues.

Copy link
Collaborator Author

@TerminalGravity TerminalGravity left a comment

Choose a reason for hiding this comment

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

Every project needs a TROUBLESHOOTING.md — this'll save a lot of issue triage. 👍

Adds a ready-to-use CLAUDE.md template that makes Claude Code
automatically run preflight_check on prompts. Users can copy it
into their project to get preflight working without manual tool calls.

Referenced from Quick Start in README and examples/README.
- CLI now responds to --help/-h with usage info, profiles, and links
- CLI now responds to --version/-v with package version
- Previously, any flag just launched the interactive wizard
- Fixed README badge from Node 18+ to Node 20+ (matches engines field)
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