docs: add terminal backend and windows troubleshooting#980
Open
aydnOktay wants to merge 1 commit intoNousResearch:mainfrom
Open
docs: add terminal backend and windows troubleshooting#980aydnOktay wants to merge 1 commit intoNousResearch:mainfrom
aydnOktay wants to merge 1 commit intoNousResearch:mainfrom
Conversation
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.
PR improves the documentation around terminal backends and Windows-specific encoding issues.
In website/docs/user-guide/configuration.md, add a “Common Terminal Backend Issues” subsection under Terminal Backend Configuration, covering:
Docker backend requirements (docker CLI in PATH, daemon running, how to fall back to local).
SSH backend requirements (TERMINAL_SSH_HOST and TERMINAL_SSH_USER must both be set).
Modal backend requirements (either MODAL_TOKEN_ID or ~/.modal.toml must be present).
A simple recommendation to switch back to the local backend when in doubt.
In website/docs/guides/tips.md, add a short “Avoid Windows Encoding Pitfalls” tip explaining how to:
Open files with encoding="utf-8" in Python to avoid UnicodeEncodeError.
Configure PowerShell to use UTF-8 output so local behavior matches CI and prevents Windows-only test failures.