Skip to content

docs: add troubleshooting section#209

Open
TerminalGravity wants to merge 2 commits intomainfrom
docs/troubleshooting-faq
Open

docs: add troubleshooting section#209
TerminalGravity wants to merge 2 commits intomainfrom
docs/troubleshooting-faq

Conversation

@TerminalGravity
Copy link
Collaborator

Adds a Troubleshooting section to README covering 8 common setup issues: LanceDB errors, model download, API keys, MCP registration, CLAUDE_PROJECT_DIR, YAML parsing, missing sessions, and Ollama.

- examples/.preflight/config.yml — profile, related projects, thresholds, embeddings
- examples/.preflight/triage.yml — keyword rules and strictness tuning
- examples/.preflight/contracts/api.yml — manual cross-service contract definitions
- examples/README.md — quick setup instructions
- README.md — link to examples from config reference section
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.

Reviewed — this looks good to merge. Covers the 8 most common setup issues cleanly, and the example config directory is a nice onboarding touch. This supersedes #177, which can be closed once this lands.

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