docs: add a troubleshooting guide for common setup errors - #136
Merged
Conversation
New users were hitting the same handful of errors and had nowhere to look: a missing/invalid provider key, port 7070 already in use, the expected 402 budget halt (which reads like a failure but is the kill switch working), the schema-newer-than-binary downgrade guard, API-auth 401s, and OTLP export/ingress misconfiguration. Add docs/TROUBLESHOOTING.md as a skimmable symptom -> cause -> fix guide. Every entry quotes the exact message the daemon emits (grepped from the code, not invented) so users can match what they see, and it leads with 'riskkernel doctor' since that catches most of these before they bite. Link it from the README quickstart.
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.
New users keep hitting the same handful of errors with nowhere to look them up. The expected 402 budget halt is the worst offender — it reads like a failure but it's the kill switch working exactly as designed.
This adds
docs/TROUBLESHOOTING.md, a skimmable symptom → cause → fix guide covering:anthropic: missing API key, the 502provider_errorpassthrough)HaltReasonit carries — explicitly called out as not-a-bugon-disk schema is newer than this binary)Every entry quotes the exact message the daemon emits — I grepped each string out of the code rather than inventing any, so users can match what they see on screen. It leads with
riskkernel doctorsince that catches most of these before they bite, and matches the tone of the existing docs (BUDGETS/RESUME/METRICS).Also linked from the README quickstart and added a CHANGELOG entry under Unreleased.
Closes #96