docs: align terminal-backend count and naming across docs and code (salvage #19044) - #20402
Merged
Conversation
README:24 claimed "Six terminal backends" while tools/environments/ exposes seven top-level backend choices through TERMINAL_ENV: local, docker, ssh, singularity, modal, daytona, vercel_sandbox. Modal additionally has direct and Nous-managed modes selected via terminal.modal_mode (the ManagedModalEnvironment class is a Modal sub-mode, not a separate top-level backend). The same drift appeared in five other doc and code-comment sites with inconsistent counts (six, seven, or implicit) and varying lists. Updated all sites to a consistent seven-backend list in canonical order. The configuration guide also clarifies how Modal's two modes are selected so operators do not search for a non-existent backend: managed_modal value. CONTRIBUTING.md:160 lists six backend filenames in a code tree but does not carry the "Six terminal" prose; left out of scope per cohesion sweep guidance to bundle only identical wording. Files updated: - README.md (line 24, marketing copy) - website/docs/index.md (line 49, landing page) - website/docs/user-guide/configuration.md (line 86, config guide) - tools/environments/__init__.py (lines 3-6, package docstring) - tools/file_operations.py (line 6, module docstring) - environments/README.md (line 43, RL training docs — TERMINAL_ENV list)
alt-glitch
added
type/docs
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
3 participants
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.
Updates README + env docs + module docstrings to list terminal backends as 7 (local, Docker, SSH, Singularity, Modal, Daytona, Vercel Sandbox) and uses the same ordering everywhere. Current
website/docs/index.mdon main already reflects this and was kept as-is during the salvage conflict.Changes:
README.md— 6 → 7 in Runs-anywhere feature (+1/-1)environments/README.md— backend list ordering fix (+1/-1)tools/environments/__init__.py— module docstring backend list (+2/-2)tools/file_operations.py— docstring backend list (+1/-1)website/docs/user-guide/configuration.md— Modal direct/managed clarification (+1/-1)scripts/release.py— AUTHOR_MAP entry for deep-nameVerified against
ls tools/environments/*.py: local, docker, ssh, singularity, modal, daytona, vercel_sandbox = 7 (plus managed_modal variant).Closes #19044 via salvage.
Original PR by @deep-name — authorship preserved.