From 7e1f5249dc6d8913d05409fef969f02d14920224 Mon Sep 17 00:00:00 2001 From: Ammar Date: Thu, 4 Dec 2025 16:16:35 -0600 Subject: [PATCH] =?UTF-8?q?=F0=9F=A4=96=20fix:=20use=20clean=20URLs=20in?= =?UTF-8?q?=20docs=20links?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Replace .md file links with clean URLs for Mintlify compatibility. Files updated: - docs/runtime.md - docs/agentic-git-identity.md - docs/project-secrets.md - docs/workspaces.md - docs/runtime/ssh.md - docs/models.md - docs/vscode-extension.md - docs/index.md - docs/mux-codes.md _Generated with mux_ --- docs/agentic-git-identity.md | 2 +- docs/index.md | 8 ++++---- docs/models.md | 2 +- docs/mux-codes.md | 2 +- docs/project-secrets.md | 2 +- docs/runtime.md | 12 ++++++------ docs/runtime/ssh.md | 4 ++-- docs/vscode-extension.md | 4 ++-- docs/workspaces.md | 10 +++++----- 9 files changed, 23 insertions(+), 23 deletions(-) diff --git a/docs/agentic-git-identity.md b/docs/agentic-git-identity.md index c69cf89f16..48cccf1d2f 100644 --- a/docs/agentic-git-identity.md +++ b/docs/agentic-git-identity.md @@ -44,7 +44,7 @@ Classic tokens are easier to configure than fine-grained tokens for repository a ## Step 3: Configure Git Identity -Add the Git identity environment variables as [Project Secrets](./project-secrets.md) in mux: +Add the Git identity environment variables as [Project Secrets](/project-secrets) in mux: 1. Open mux and find your project in the sidebar 2. Click the 🔑 key icon to open the secrets modal diff --git a/docs/index.md b/docs/index.md index fb80c37dba..40e9d4a541 100644 --- a/docs/index.md +++ b/docs/index.md @@ -18,10 +18,10 @@ mux helps you work with multiple coding assistants more effectively via: ## Quick Links -- [Install](./install.md) - Download and installation instructions -- [Why Parallelize?](./why-parallelize.md) - Why parallelize? -- [Keyboard Shortcuts](./keybinds.md) - Complete keyboard reference -- [AGENTS](./AGENTS.md) - Developer guide for AI assistants +- [Install](/install) - Download and installation instructions +- [Why Parallelize?](/why-parallelize) - Why parallelize? +- [Keyboard Shortcuts](/keybinds) - Complete keyboard reference +- [AGENTS](/AGENTS) - Developer guide for AI assistants ## License diff --git a/docs/models.md b/docs/models.md index 53a374d66f..b383c574ec 100644 --- a/docs/models.md +++ b/docs/models.md @@ -5,7 +5,7 @@ description: Configure AI providers including Anthropic, OpenAI, Google, xAI, an See also: -- [System Prompt](./system-prompt.md) +- [System Prompt](/system-prompt) mux supports multiple AI providers through its flexible provider architecture. diff --git a/docs/mux-codes.md b/docs/mux-codes.md index 720f383382..b2a595a1de 100644 --- a/docs/mux-codes.md +++ b/docs/mux-codes.md @@ -10,7 +10,7 @@ A code looks like `ABC-123`. Redemption is straightforward: 1. Go to [gateway.mux.coder.com](https://gateway.mux.coder.com) and follow instructions to enable the code. -1. Open Mux (see [install](./install.md) for instructions) +1. Open Mux (see [install](/install) for instructions) 1. Click the Settings icon in the top left corner (Cmd+, on macOS) 1. Under Providers, enter the code under Mux Gateway: ![Mux Gateway Code](./img/mux-gateway-code.webp) diff --git a/docs/project-secrets.md b/docs/project-secrets.md index bba674a36a..457e1cdb93 100644 --- a/docs/project-secrets.md +++ b/docs/project-secrets.md @@ -54,4 +54,4 @@ The agent doesn't need to explicitly reference secrets - they're available as re ## Related -- [Agentic Git Identity](./agentic-git-identity.md) - Configure Git credentials for AI commits using Project Secrets +- [Agentic Git Identity](/agentic-git-identity) - Configure Git credentials for AI commits using Project Secrets diff --git a/docs/runtime.md b/docs/runtime.md index 78c9d019c7..0a72f047cf 100644 --- a/docs/runtime.md +++ b/docs/runtime.md @@ -5,11 +5,11 @@ description: Configure where and how mux executes agent workspaces Runtimes determine where and how mux executes agent workspaces. -| Runtime | Isolation | Best For | -| ------------------------------------- | ------------------------------------------ | ---------------------------------------- | -| **[Local](./runtime/local.md)** | All workspaces share the project directory | Quick edits to your working copy | -| **[Worktree](./runtime/worktree.md)** | Each workspace gets its own directory | Running multiple agents in parallel | -| **[SSH](./runtime/ssh.md)** | Remote execution over SSH | Security, performance, heavy parallelism | +| Runtime | Isolation | Best For | +| --------------------------------- | ------------------------------------------ | ---------------------------------------- | +| **[Local](/runtime/local)** | All workspaces share the project directory | Quick edits to your working copy | +| **[Worktree](/runtime/worktree)** | Each workspace gets its own directory | Running multiple agents in parallel | +| **[SSH](/runtime/ssh)** | Remote execution over SSH | Security, performance, heavy parallelism | ## Choosing a Runtime @@ -17,7 +17,7 @@ When creating a workspace, select the runtime from the dropdown in the workspace ## Init Hooks -[Init hooks](./init-hooks.md) can detect the runtime type via the `MUX_RUNTIME` environment variable: +[Init hooks](/init-hooks) can detect the runtime type via the `MUX_RUNTIME` environment variable: - `local` — Local runtime - `worktree` — Worktree runtime diff --git a/docs/runtime/ssh.md b/docs/runtime/ssh.md index 27fe3d4c58..2a8277733d 100644 --- a/docs/runtime/ssh.md +++ b/docs/runtime/ssh.md @@ -6,12 +6,12 @@ description: Run agents on remote hosts over SSH for security and performance mux supports using remote hosts over SSH for workspaces. When configured, all tool operations will execute over SSH and the agent is securely isolated from your local machine. -Our security architecture considers the remote machine potentially hostile. No keys or credentials are implicitly transferred there—just the git archive and [Project Secrets](../project-secrets.md). +Our security architecture considers the remote machine potentially hostile. No keys or credentials are implicitly transferred there—just the git archive and [Project Secrets](/project-secrets). We highly recommend using SSH workspaces for an optimal experience: - **Security**: Prompt injection risk is contained to the credentials / files on the remote machine. - - SSH remotes pair nicely with [agentic git identities](../agentic-git-identity.md) + - SSH remotes pair nicely with [agentic git identities](/agentic-git-identity) - **Performance**: Run many, many agents in parallel while maintaining good battery life and UI performance ![ssh workspaces](../img/new-workspace-ssh.webp) diff --git a/docs/vscode-extension.md b/docs/vscode-extension.md index 6b4f0b1f02..e09e789dca 100644 --- a/docs/vscode-extension.md +++ b/docs/vscode-extension.md @@ -87,6 +87,6 @@ repository. ## Related -- [Workspaces Overview](./workspaces.md) -- [SSH Runtime](./runtime/ssh.md) +- [Workspaces Overview](/workspaces) +- [SSH Runtime](/runtime/ssh) - [VS Code Remote-SSH Documentation](https://code.visualstudio.com/docs/remote/ssh) diff --git a/docs/workspaces.md b/docs/workspaces.md index 61f606ab7e..39ceb37613 100644 --- a/docs/workspaces.md +++ b/docs/workspaces.md @@ -7,13 +7,13 @@ Workspaces in mux provide isolated development environments for parallel agent w ## Runtimes -mux supports three [runtime types](./runtime.md): +mux supports three [runtime types](/runtime): -- **[Local](./runtime/local.md)**: Run directly in your project directory. No isolation—best for quick edits to your working copy. +- **[Local](/runtime/local)**: Run directly in your project directory. No isolation—best for quick edits to your working copy. -- **[Worktree](./runtime/worktree.md)**: Isolated directories using [git worktrees](https://git-scm.com/docs/git-worktree). Worktrees share `.git` with your main repository while maintaining independent working changes. +- **[Worktree](/runtime/worktree)**: Isolated directories using [git worktrees](https://git-scm.com/docs/git-worktree). Worktrees share `.git` with your main repository while maintaining independent working changes. -- **[SSH](./runtime/ssh.md)**: Remote execution over SSH. Ideal for heavy workloads, security isolation, or leveraging remote infrastructure. +- **[SSH](/runtime/ssh)**: Remote execution over SSH. Ideal for heavy workloads, security isolation, or leveraging remote infrastructure. ## Choosing a Runtime @@ -35,7 +35,7 @@ The runtime is selected when you create a workspace: Here are a few practical approaches to reviewing changes from workspaces, depending on how much you want your agent to interact with `git`: - **Agent codes, commits, and pushes**: Ask agent to submit a PR and review changes in your git Web UI (GitHub, GitLab, etc.) - - Also see: [Agentic Git Identity](./agentic-git-identity.md) + - Also see: [Agentic Git Identity](/agentic-git-identity) - This is the preferred approach for `mux` development but requires additional care with repository security. - **Agent codes and commits**: Review changes from the main repository via `git diff `, push changes when deemed acceptable. - **Agent codes**: Enter worktree (click Terminal icon in workspace top bar), run `git add -p` and progressively accept changes into a commit.