Skip to content

docs(docs): document Toolbox support bundle requirements - #31289

Merged
fioan89 merged 5 commits into
mainfrom
doc/toolbox-support-bundle-requirements
Oct 26, 2026
Merged

fioan89 merged 5 commits into
mainfrom
doc/toolbox-support-bundle-requirements

Conversation

@fioan89

@fioan89 fioan89 commented Oct 26, 2026

Copy link
Copy Markdown
Collaborator

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

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
@linear-code

linear-code Bot commented Oct 26, 2026

Copy link
Copy Markdown

JET-11

@fioan89
fioan89 requested review from matifali and removed request for nickvigilante October 26, 2026 17:06
@github-actions github-actions Bot added the community Pull Requests and issues created by the community. label Oct 26, 2026
@fioan89
fioan89 requested a review from nickvigilante October 26, 2026 17:06
@github-actions

github-actions Bot commented Oct 26, 2026 •

Copy link
Copy Markdown
Contributor

Docs preview

Check 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 matifali left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's also get a review from @nickvigilante

Comment thread docs/support/support-bundle.md Resolved

@nickvigilante nickvigilante left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few nits, and agree with Atif's findings, but otherwise, LGTM! :shipit: 🚀

Comment thread docs/support/support-bundle.md Resolved
Comment thread docs/support/support-bundle.md Resolved
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.
@fioan89
fioan89 merged commit e4e62d9 into main Oct 26, 2026
28 checks passed
@fioan89
fioan89 deleted the doc/toolbox-support-bundle-requirements branch October 26, 2026 19:06
@github-actions github-actions Bot locked and limited conversation to collaborators Oct 26, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

community Pull Requests and issues created by the community.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants