Skip to content

Commit b061c16

Browse files
authored
🤖 fix: use clean URLs in docs links (#917)
Replace `.md` file links with clean URLs for Mintlify compatibility. For example: `[install](./install.md)` → `[install](/install)` **Files updated:** 9 docs files with internal links _Generated with mux_
1 parent 9c53447 commit b061c16

File tree

9 files changed

+23
-23
lines changed

9 files changed

+23
-23
lines changed

‎docs/agentic-git-identity.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Classic tokens are easier to configure than fine-grained tokens for repository a
4444

4545
## Step 3: Configure Git Identity
4646

47-
Add the Git identity environment variables as [Project Secrets](./project-secrets.md) in mux:
47+
Add the Git identity environment variables as [Project Secrets](/project-secrets) in mux:
4848

4949
1. Open mux and find your project in the sidebar
5050
2. Click the 🔑 key icon to open the secrets modal

‎docs/index.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,10 @@ mux helps you work with multiple coding assistants more effectively via:
1818

1919
## Quick Links
2020

21-
- [Install](./install.md) - Download and installation instructions
22-
- [Why Parallelize?](./why-parallelize.md) - Why parallelize?
23-
- [Keyboard Shortcuts](./keybinds.md) - Complete keyboard reference
24-
- [AGENTS](./AGENTS.md) - Developer guide for AI assistants
21+
- [Install](/install) - Download and installation instructions
22+
- [Why Parallelize?](/why-parallelize) - Why parallelize?
23+
- [Keyboard Shortcuts](/keybinds) - Complete keyboard reference
24+
- [AGENTS](/AGENTS) - Developer guide for AI assistants
2525

2626
## License
2727

‎docs/models.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Configure AI providers including Anthropic, OpenAI, Google, xAI, an
55

66
See also:
77

8-
- [System Prompt](./system-prompt.md)
8+
- [System Prompt](/system-prompt)
99

1010
mux supports multiple AI providers through its flexible provider architecture.
1111

‎docs/mux-codes.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ A code looks like `ABC-123`.
1010
Redemption is straightforward:
1111

1212
1. Go to [gateway.mux.coder.com](https://gateway.mux.coder.com) and follow instructions to enable the code.
13-
1. Open Mux (see [install](./install.md) for instructions)
13+
1. Open Mux (see [install](/install) for instructions)
1414
1. Click the Settings icon in the top left corner (Cmd+, on macOS)
1515
1. Under Providers, enter the code under Mux Gateway:
1616
![Mux Gateway Code](./img/mux-gateway-code.webp)

‎docs/project-secrets.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,4 +54,4 @@ The agent doesn't need to explicitly reference secrets - they're available as re
5454

5555
## Related
5656

57-
- [Agentic Git Identity](./agentic-git-identity.md) - Configure Git credentials for AI commits using Project Secrets
57+
- [Agentic Git Identity](/agentic-git-identity) - Configure Git credentials for AI commits using Project Secrets

‎docs/runtime.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,19 @@ description: Configure where and how mux executes agent workspaces
55

66
Runtimes determine where and how mux executes agent workspaces.
77

8-
| Runtime | Isolation | Best For |
9-
| ------------------------------------- | ------------------------------------------ | ---------------------------------------- |
10-
| **[Local](./runtime/local.md)** | All workspaces share the project directory | Quick edits to your working copy |
11-
| **[Worktree](./runtime/worktree.md)** | Each workspace gets its own directory | Running multiple agents in parallel |
12-
| **[SSH](./runtime/ssh.md)** | Remote execution over SSH | Security, performance, heavy parallelism |
8+
| Runtime | Isolation | Best For |
9+
| --------------------------------- | ------------------------------------------ | ---------------------------------------- |
10+
| **[Local](/runtime/local)** | All workspaces share the project directory | Quick edits to your working copy |
11+
| **[Worktree](/runtime/worktree)** | Each workspace gets its own directory | Running multiple agents in parallel |
12+
| **[SSH](/runtime/ssh)** | Remote execution over SSH | Security, performance, heavy parallelism |
1313

1414
## Choosing a Runtime
1515

1616
When creating a workspace, select the runtime from the dropdown in the workspace creation UI.
1717

1818
## Init Hooks
1919

20-
[Init hooks](./init-hooks.md) can detect the runtime type via the `MUX_RUNTIME` environment variable:
20+
[Init hooks](/init-hooks) can detect the runtime type via the `MUX_RUNTIME` environment variable:
2121

2222
- `local` — Local runtime
2323
- `worktree` — Worktree runtime

‎docs/runtime/ssh.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ description: Run agents on remote hosts over SSH for security and performance
66
mux supports using remote hosts over SSH for workspaces. When configured, all tool operations will
77
execute over SSH and the agent is securely isolated from your local machine.
88

9-
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).
9+
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).
1010

1111
We highly recommend using SSH workspaces for an optimal experience:
1212

1313
- **Security**: Prompt injection risk is contained to the credentials / files on the remote machine.
14-
- SSH remotes pair nicely with [agentic git identities](../agentic-git-identity.md)
14+
- SSH remotes pair nicely with [agentic git identities](/agentic-git-identity)
1515
- **Performance**: Run many, many agents in parallel while maintaining good battery life and UI performance
1616

1717
![ssh workspaces](../img/new-workspace-ssh.webp)

‎docs/vscode-extension.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,6 @@ repository.
8787

8888
## Related
8989

90-
- [Workspaces Overview](./workspaces.md)
91-
- [SSH Runtime](./runtime/ssh.md)
90+
- [Workspaces Overview](/workspaces)
91+
- [SSH Runtime](/runtime/ssh)
9292
- [VS Code Remote-SSH Documentation](https://code.visualstudio.com/docs/remote/ssh)

‎docs/workspaces.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ Workspaces in mux provide isolated development environments for parallel agent w
77

88
## Runtimes
99

10-
mux supports three [runtime types](./runtime.md):
10+
mux supports three [runtime types](/runtime):
1111

12-
- **[Local](./runtime/local.md)**: Run directly in your project directory. No isolation—best for quick edits to your working copy.
12+
- **[Local](/runtime/local)**: Run directly in your project directory. No isolation—best for quick edits to your working copy.
1313

14-
- **[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.
14+
- **[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.
1515

16-
- **[SSH](./runtime/ssh.md)**: Remote execution over SSH. Ideal for heavy workloads, security isolation, or leveraging remote infrastructure.
16+
- **[SSH](/runtime/ssh)**: Remote execution over SSH. Ideal for heavy workloads, security isolation, or leveraging remote infrastructure.
1717

1818
## Choosing a Runtime
1919

@@ -35,7 +35,7 @@ The runtime is selected when you create a workspace:
3535
Here are a few practical approaches to reviewing changes from workspaces, depending on how much you want your agent to interact with `git`:
3636

3737
- **Agent codes, commits, and pushes**: Ask agent to submit a PR and review changes in your git Web UI (GitHub, GitLab, etc.)
38-
- Also see: [Agentic Git Identity](./agentic-git-identity.md)
38+
- Also see: [Agentic Git Identity](/agentic-git-identity)
3939
- This is the preferred approach for `mux` development but requires additional care with repository security.
4040
- **Agent codes and commits**: Review changes from the main repository via `git diff <workspace-branch>`, push changes when deemed acceptable.
4141
- **Agent codes**: Enter worktree (click Terminal icon in workspace top bar), run `git add -p` and progressively accept changes into a commit.

0 commit comments

Comments
 (0)