docs: add file sync warning to coder_agent dir attribute

Author: zenithwolf1000

docs/resources/agent.md

@@ -76,6 +76,8 @@ resource "kubernetes_pod" "dev" {
 - `auth` (String) The authentication type the agent will use. Must be one of: `"token"`, `"google-instance-identity"`, `"aws-instance-identity"`, `"azure-instance-identity"`.
 - `connection_timeout` (Number) Time in seconds until the agent is marked as timed out when a connection with the server cannot be established. A value of zero never marks the agent as timed out.
 - `dir` (String) The starting directory when a user creates a shell session. Defaults to `"$HOME"`.
+
+~> **Warning:** Setting `dir` to a value other than `$HOME` will break [Coder Desktop file sync](https://coder.com/docs/user-guides/desktop/desktop-connect-sync).
 - `display_apps` (Block Set, Max: 1) The list of built-in apps to display in the agent bar. (see [below for nested schema](#nestedblock--display_apps))
 - `env` (Map of String) A mapping of environment variables to set inside the workspace.
 - `metadata` (Block List) Each `metadata` block defines a single item consisting of a key/value pair. This feature is in alpha and may break in future releases. (see [below for nested schema](#nestedblock--metadata))

provider/agent.go

@@ -115,7 +115,9 @@ func agentResource() *schema.Resource {
 				Type:        schema.TypeString,
 				ForceNew:    true,
 				Optional:    true,
-				Description: "The starting directory when a user creates a shell session. Defaults to `\"$HOME\"`.",
+				Description: "The starting directory when a user creates a shell session. Defaults to `\"$HOME\"`." +
+					"\n\n~> **Warning:** Setting `dir` to a value other than `$HOME` will break " +
+					"[Coder Desktop file sync](https://coder.com/docs/user-guides/desktop/desktop-connect-sync).",
 			},
 			"env": {
 				ForceNew:    true,