Repository navigation
docs(docs): document Toolbox support bundle requirements - #31289
Merged
Merged
Conversation
The support bundle guide covers CLI and VS Code collection but does not explain the requirements or collection flow for JetBrains Toolbox. The Toolbox installation guide also lists an outdated minimum version. This commit updates both guides with the minimum Coder plugin, Toolbox, and CLI versions. The support bundle guide now explains how the Toolbox plugin collects Coder diagnostics and local SSH logs, what the archive contains, and what remains available when bundle generation fails. The collection steps now start from the environment list shown after sign-in and use the environment's action menu, so users can follow the Toolbox interface directly. Each environment represents a workspace and agent pair. -resolves https://linear.app/codercom/issue/JET-11/document-toolbox-support-bundle-version-requirements-in-coder-docs
Contributor
Docs previewCheck off each page once it's been reviewed. If a page changes in a later push, its checkbox clears automatically so it gets a fresh look. Pages not yet wired into the docs navigation aren't listed here. |
matifali
approved these changes
Oct 26, 2026
matifali
left a comment
Contributor
There was a problem hiding this comment.
Let's also get a review from @nickvigilante
nickvigilante
approved these changes
Oct 26, 2026
nickvigilante
left a comment
Collaborator
There was a problem hiding this comment.
A few nits, and agree with Atif's findings, but otherwise, LGTM!
🚀
The support bundle and Toolbox guides specify a minimum Coder CLI version even though Coder documentation is already versioned. These requirements duplicate the version context provided by the docs. This commit removes the repeated CLI version requirements and the custom CLI version reminder. The guides retain minimum versions for the independently versioned Coder plugin and JetBrains Toolbox, so readers still have the compatibility requirements for those components. -resolves https://linear.app/codercom/issue/JET-11/document-toolbox-support-bundle-version-requirements-in-coder-docs
The support bundle guide uses "ensure" when describing custom CLI requirements. This commit replaces "ensure" with "make sure" to use plainer wording while preserving the requirement. -resolves https://linear.app/codercom/issue/JET-11/document-toolbox-support-bundle-version-requirements-in-coder-docs
The support bundle guide uses "attempts to write" when describing the Toolbox plugin's error-reporting behavior. This commit replaces the phrase with "tries to write" to use plainer wording while preserving the description of bundle generation failures. -resolves https://linear.app/codercom/issue/JET-11/document-toolbox-support-bundle-version-requirements-in-coder-docs
The Toolbox documentation branch is behind main. This merge brings the branch up to date with the latest main changes while retaining the support bundle requirements and wording updates.
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
The support bundle guide covers CLI and VS Code collection but does not explain the requirements or collection flow for JetBrains Toolbox. The Toolbox installation guide also lists an outdated minimum version.
This commit updates both guides with the minimum Coder plugin, Toolbox, and CLI versions. The support bundle guide now explains how the Toolbox plugin collects Coder diagnostics and local SSH logs, what the archive contains, and what remains available when bundle generation fails.
The collection steps now start from the environment list shown after sign-in and use the environment's action menu, so users can follow the Toolbox interface directly. Each environment represents a workspace and agent pair.
-resolves https://linear.app/codercom/issue/JET-11/document-toolbox-support-bundle-version-requirements-in-coder-docs