Skip to content

docs: add file sync to coder desktop docs #17463

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.

Sign up for GitHub

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

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

docs: add file sync to coder desktop docs #17463

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
940bfe6
beta tag; confirm steps
EdwardAngert Apr 17, 2025
749d839
desktop file sync
EdwardAngert Apr 17, 2025
9dd403e
Merge branch 'main' into 16869-desktop-file-sync
EdwardAngert Apr 17, 2025
b1f9356
sync direction and merge conflict resolution
EdwardAngert Apr 21, 2025
c43c528
add status tooltip
EdwardAngert Apr 22, 2025
42e7648
file sync conflicts
EdwardAngert Apr 22, 2025
e02a3ab
Merge branch 'main' into 16869-desktop-file-sync
EdwardAngert Apr 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
desktop file sync
  • Loading branch information
@EdwardAngert
EdwardAngert committed Apr 17, 2025
commit 749d839f38e858e6501df4ef22194208b788a160
Binary file added docs/images/user-guides/desktop/coder-desktop-file-sync-add.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/user-guides/desktop/coder-desktop-file-sync-staging.png
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

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

One thing users might not pick up on is that they can hover over the Status (or either path, or the size) for a longer description of it, or, in the case of file sync conflicts, to see what files are conflicting. Can one of these screenshots include the user hovering over the status?

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 added a line to the steps about the mouseover, and added a File sync conflicts section in 42e7648

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/user-guides/desktop/coder-desktop-file-sync-watching.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/user-guides/desktop/coder-desktop-file-sync.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/user-guides/desktop/coder-desktop-workspaces.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 20 additions & 0 deletions docs/user-guides/desktop/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,26 @@ Use `ping` in a Command Prompt or PowerShell terminal to verify the connection t

</div>

## Sync a local directory with your workspace

If you're working offline or adding screenshots to your documentation, Coder Desktop file sync can make it easier to move files to your workspace.

1. Create a new local directory.

If you select an existing clone of your repository, Desktop will recognize it as conflicting files.

1. In the Coder Desktop app, select **File sync**.

![Coder Desktop File Sync screen](../../images/user-guides/desktop/coder-desktop-file-sync.png)

1. Select the **+** in the corner to select the local path, workspace, and remote path, then select **Add**:

![Coder Desktop File Sync add paths](../../images/user-guides/desktop/coder-desktop-file-sync-add.png)

1. File sync clones your workspace directory to your local directory, then watches for changes:

![Coder Desktop File Sync watching](../../images/user-guides/desktop/coder-desktop-file-sync-watching.png)

## Accessing web apps in a secure browser context

Some web applications require a [secure context](https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts) to function correctly.
Expand Down