Repository navigation
docs: add TROUBLESHOOTING.md - #14
Merged
Vedantgitbot merged 2 commits intoOct 12, 2026
Merged
Conversation
Owner
|
@AkashGoswamy , This is great, thanks. Exactly the format I wanted, and the extra "rule of thumb" notes are a nice touch. One fix before merging: link "the Anthropic example" in entry 6, like the others (examples/opencode13241-eng_anthropic). Also, entry 1 is correctly worded as-is, v0.5.3 fixed a related on_attempt bug, but the core issue (exceptions looking like UNCERTAIN) is still open. Good that you kept that distinction accurate. Merging once the link's added. |
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
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.
Closes #12
What does this change?
Adds
TROUBLESHOOTING.mdat the repo root, compiling the six known gotchas from the issue into one discoverable file. Each entry follows symptom → cause → what to do, with links back to the source examples. Also adds one line linking to it from the "Learn More" section ofREADME.md.Why?
The gotchas currently sit in separate
examples/*/RESULTS.mdfiles, so users hitting them are unlikely to find them. This is the documentation-only task requested in #12. I read CONTRIBUTING.md and the RESULTS.md files from the examples before writing, so each entry reflects what was observed in a real run.Checklist
pytest -v) and it passes. — N/A, documentation only, no code changedCHANGELOG.mdentry following the existing format. — N/A, no behavior changeAnything else worth knowing?
Entry 1 says "as of v0.5.3" because I found no release note showing
check()now surfaces exceptions. If that behavior has changed onmain, I'm happy to update the entry.