Skip to content

docs: add Coder Desktop early preview documentation #16544

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 32 commits into from
Mar 4, 2025
Merged

Conversation

EdwardAngert
Copy link
Contributor

@EdwardAngert EdwardAngert commented Feb 12, 2025

closes #16540
closes coder/coder-desktop-macos#75

  • replace placeholder icon images/icons/computer-code.svg
  • add install steps
  • outline what works in alpha early access alpha early access
  • Update instructions for Zed and Fleet IDE and any SSH-based IDE in general to use with Coder Desktop. (labeled as Alpha) may use tabs.
  • @matifali : do you have windows install steps?

preview

@EdwardAngert EdwardAngert added the docs Area: coder.com/docs label Feb 12, 2025
@matifali matifali changed the title docs: add Coder Desktop beta documentation docs: add Coder Desktop Alpha documentation Feb 18, 2025
@EdwardAngert

This comment was marked as resolved.

@matifali
Copy link
Member

matifali commented Feb 19, 2025

This will work with the next release. Sorry for not sharing this before. We only have the preview formula published for now.
@ThomasK33 can confirm.
@ethanndickson when can we push a new release?


## Configure

Before you can use Coder Desktop, you will need to approve the system extension and log in.
Copy link
Member

Choose a reason for hiding this comment

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

Do we want to move this to a macOS-specific heading or tab?
I'm guessing that the Windows configuration steps will be different.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I adjusted the step per @ethanndickson 's suggestion and that moved the configuration step into the mac-specific section

I think the rest of the configuration should be the same, but I haven't been able to try the Windows version yet

@EdwardAngert EdwardAngert changed the title docs: add Coder Desktop Alpha documentation docs: add Coder Desktop early access documentation Feb 26, 2025
@EdwardAngert
Copy link
Contributor Author

@matifali @deansheather do you have the steps to install Desktop on windows?

@EdwardAngert
Copy link
Contributor Author

EdwardAngert commented Feb 26, 2025

I'll try to test this on windows today we don't have windows in this house

@EdwardAngert EdwardAngert marked this pull request as ready for review February 27, 2025 04:55
"description": "Use Coder Desktop to access your workspace like it's a local machine",
"path": "./user-guides/desktop/index.md",
"icon_path": "./images/icons/computer-code.svg",
"state": ["beta"]
Copy link
Contributor Author

Choose a reason for hiding this comment

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

leaving this as beta for now because we don't have an earlyaccess badge

Copy link
Member

Choose a reason for hiding this comment

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

FYI @bpmct.
@EdwardAngert I would opt for alpha over beta in this case. We do support that.


1. Coder Desktop starts minimized in the Windows System Tray.

You might need to select the **^** in your system tray to show more icons.
Copy link
Member

Choose a reason for hiding this comment

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

Maybe add a comment about how you can pin it by going to (at least on Win 11) Settings > Personalization > Taskbar > Other system tray icons, then enabling Coder Desktop

@deansheather
Copy link
Member

Sorry about the lateness with the Windows installer and thanks for writing the docs!

@ethanndickson
Copy link
Member

Note for myself, or whoever continues writing the docs, that we should document that the other Coder tools (coder ssh, IDE extensions, etc.) do not currently leverage the connections created by Coder Desktop, and that they currently start separate connections to the workspace.

ethanndickson and others added 2 commits March 3, 2025 04:11
Co-authored-by: Dean Sheather <dean@deansheather.com>
@deansheather deansheather requested a review from bpmct March 3, 2025 04:24
Copy link
Member

@matifali matifali left a comment

Choose a reason for hiding this comment

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

A few comments but LGTM.
I would like @the-dietcoke-ofevil and @mattvollmer to have a look too.

@ethanndickson ethanndickson changed the title docs: add Coder Desktop early access documentation docs: add Coder Desktop alpha documentation Mar 3, 2025
@matifali matifali changed the title docs: add Coder Desktop alpha documentation docs: add Coder Desktop early preview documentation Mar 3, 2025
@bpmct
Copy link
Member

bpmct commented Mar 4, 2025

https://github.com/coder/coder.com/pull/829

@matifali matifali merged commit 73057eb into main Mar 4, 2025
31 of 32 checks passed
@matifali matifali deleted the 16540-desktop-beta branch March 4, 2025 17:27
@github-actions github-actions bot locked and limited conversation to collaborators Mar 4, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
docs Area: coder.com/docs
Projects
None yet
6 participants