Skip to content

Commit 002200b

Browse files
mattvollmermattvollmer
committed
migrate docs
1 parent 2c91806 commit 002200b

36 files changed

+318
-754
lines changed

‎docs/AGENTS.md‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
# AGENT INSTRUCTIONS
1+
---
2+
title: AGENTS.md
3+
description: Agent instructions for AI assistants working on the mux codebase
4+
---
25

36
**Prime directive:** keep edits minimal and token-efficient—say only what conveys actionable signal.
47

@@ -153,7 +156,7 @@ Avoid mock-heavy tests that verify implementation details rather than behavior.
153156
- Prefer fixes that simplify existing code; such simplifications often do not need new tests.
154157
- When adding complexity, add or extend tests. If coverage requires new infrastructure, propose the harness and then add the tests there.
155158

156-
<!-- IMPORTANT: Do not rename these Mode headings; the parser extracts them verbatim. -->
159+
{/* IMPORTANT: Do not rename these Mode headings; the parser extracts them verbatim. */}
157160

158161
## Mode: Exec
159162

‎docs/agentic-git-identity.md‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
# Agentic Git Identity
1+
---
2+
title: Agentic Git Identity
3+
description: Configure a separate Git identity for AI-generated commits
4+
---
25

36
Configure mux to use a separate Git identity for AI-generated commits, making it easy to distinguish between human and AI contributions. Reasons to use a separate identity include:
47

@@ -23,7 +26,7 @@ Create a separate GitHub account for your agent:
2326
2. Use a distinctive username (e.g., `yourname-agent`, `yourname-ai`)
2427
3. Use a separate email (GitHub allows plus-addressing: `yourname+ai@example.com`)
2528

26-
> **Note**: This is optional but recommended. You can also use your main account with a different email/name.
29+
<Info>This is optional but recommended. You can also use your main account with a different email/name.</Info>
2730

2831
## Step 2: Generate Classic GitHub Token
2932

@@ -54,7 +57,7 @@ Add the Git identity environment variables as [Project Secrets](./project-secret
5457

5558
These environment variables will be automatically injected when the agent runs Git commands in that project.
5659

57-
> **Note**: If you need the agent identity outside of mux, you can alternatively set these as global environment variables in your shell configuration (`~/.zshrc`, `~/.bashrc`, etc.)
60+
<Info>If you need the agent identity outside of mux, you can alternatively set these as global environment variables in your shell configuration (`~/.zshrc`, `~/.bashrc`, etc.)</Info>
5861

5962
## Step 4: Configure GitHub Authentication
6063

@@ -98,4 +101,4 @@ git config --global credential.helper ""
98101
git config --global --add credential.helper '!gh auth git-credential'
99102
```
100103

101-
⚠️ **Warning**: The "replace all" approach will disable platform keychain helpers and may break Git authentication for non-GitHub remotes (GitLab, Bitbucket, etc.).
104+
<Warning>The "replace all" approach will disable platform keychain helpers and may break Git authentication for non-GitHub remotes (GitLab, Bitbucket, etc.).</Warning>

‎docs/benchmarking.md‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
1-
# Terminal Benchmarking
1+
---
2+
title: Terminal Benchmarking
3+
description: Run Terminal-Bench benchmarks with the mux adapter
4+
---
25

36
mux ships with a headless adapter for [Terminal-Bench](https://www.tbench.ai/). The adapter runs the Electron backend without opening a window and exercises it through the same IPC paths we use in integration tests. This page documents how to launch benchmarks from the repository tree.
47

58
## Prerequisites
69

710
- Docker must be installed and running. Terminal-Bench executes each task inside a dedicated Docker container.
8-
- `uv` is available in the nix `devShell` (provided via `flake.nix`), or install it manually from <https://docs.astral.sh/uv/>.
11+
- `uv` is available in the nix `devShell` (provided via `flake.nix`), or install it manually from [docs.astral.sh/uv](https://docs.astral.sh/uv/).
912
- Standard provider API keys (e.g. `ANTHROPIC_API_KEY`, `OPENAI_API_KEY`) should be exported so mux can stream responses.
1013

1114
Optional environment overrides:

‎docs/cli.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
# Command Line Interface
1+
---
2+
title: Command Line Interface
3+
description: Run one-off agent tasks from the command line with mux run
4+
---
25

36
Mux provides a CLI for running one-off agent tasks without the desktop app. Unlike the interactive desktop experience, `mux run` executes a single request to completion and exits.
47

‎docs/context-management.md‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
# Context Management
1+
---
2+
title: Context Management
3+
description: Commands for managing conversation history and token usage
4+
---
25

36
Commands for managing conversation history length and token usage.
47

@@ -149,7 +152,7 @@ Remove oldest 50% of messages.
149152

150153
### OpenAI Responses API Limitation
151154

152-
⚠️ **`/truncate` does not work with OpenAI models** due to the Responses API architecture:
155+
<Warning>`/truncate` does not work with OpenAI models due to the Responses API architecture:</Warning>
153156

154157
- OpenAI's Responses API stores conversation state server-side
155158
- Manual message deletion via `/truncate` doesn't affect the server-side state

‎docs/custom.css‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
/* Override logo height */
2+
.nav-logo {
3+
height: 2.4rem !important;
4+
}
5+
6+
/* Target logo images specifically */
7+
img[src*="/img/light.svg"],
8+
img[src*="/img/dark.svg"] {
9+
height: 2.4rem !important;
10+
}
11+
12+
/* Override Tailwind h-6 class specifically for logo */
13+
.nav-logo.h-6,
14+
.h-6[src*="/img/"] {
15+
height: 2.4rem !important;
16+
}
17+
18+
/* More specific targeting for Mintlify logo classes */
19+
.w-auto.relative.object-contain.hidden.dark\:block.px-1.h-6.max-w-48,
20+
.w-auto.relative.object-contain.block.dark\:hidden.px-1.h-6.max-w-48 {
21+
height: 2.4rem !important;
22+
}
23+
24+
/* Override link colors to match grayscale theme */
25+
a,
26+
.prose a,
27+
main a,
28+
[data-testid="main-content"] a {
29+
color: #999 !important;
30+
}
31+
32+
a:hover,
33+
.prose a:hover,
34+
main a:hover,
35+
[data-testid="main-content"] a:hover {
36+
color: #FFF !important;
37+
}
38+
39+
/* Apply styling to all images in docs */
40+
main img,
41+
.prose img,
42+
[data-testid="main-content"] img,
43+
.content img {
44+
margin: 24px 0 !important;
45+
border-radius: 8px !important;
46+
}
47+
48+
/* Apply same styling to videos in docs */
49+
main video,
50+
.prose video,
51+
[data-testid="main-content"] video,
52+
.content video {
53+
margin: 24px 0 !important;
54+
border-radius: 8px !important;
55+
}
56+
57+
/* Make table headers left-aligned */
58+
main th,
59+
.prose th,
60+
[data-testid="main-content"] th,
61+
.content th {
62+
text-align: left !important;
63+
}
64+
65+
/* Hide only the Powered by Mintlify attribution in footer */
66+
[data-testid="footer-powered-by"],
67+
footer a[href*="mintlify.com"],
68+
footer a[href*="//mintlify.com"],
69+
footer a[href^="https://mintlify"],
70+
footer a[href^="http://mintlify"],
71+
footer a[href*="mintlify.app"],
72+
footer a[href*="mintcdn.com"][aria-label*="Mintlify"],
73+
footer [aria-label*="Powered by Mintlify"],
74+
footer [aria-label="Powered by Mintlify"] {
75+
display: none !important;
76+
}
77+
78+
/* Preserve footer layout even if attribution is removed */
79+
footer [data-testid="footer-powered-by"] + *,
80+
footer a[href*="mintlify.com"] + * {
81+
margin-left: 0 !important;
82+
}

‎docs/docs.json‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
{
2+
"$schema": "https://mintlify.com/docs.json",
3+
"theme": "maple",
4+
"name": "mux",
5+
"logo": {
6+
"light": "/img/light.svg",
7+
"dark": "/img/dark.svg"
8+
},
9+
"favicon": "/favicon.svg",
10+
"colors": {
11+
"primary": "#999",
12+
"light": "#FFF",
13+
"dark": "#000"
14+
},
15+
"appearance": {
16+
"default": "dark"
17+
},
18+
"interaction": {
19+
"drilldown": true
20+
},
21+
"icons": {
22+
"library": "lucide"
23+
},
24+
"css": ["/custom.css"],
25+
"navigation": {
26+
"tabs": [
27+
{
28+
"tab": "Documentation",
29+
"groups": [
30+
{
31+
"group": "Introduction",
32+
"pages": ["index", "install", "cli", "why-parallelize"]
33+
},
34+
{
35+
"group": "Features",
36+
"pages": [
37+
{
38+
"group": "Workspaces",
39+
"pages": [
40+
"workspaces",
41+
{
42+
"group": "Runtimes",
43+
"pages": ["runtime", "runtime/local", "runtime/worktree", "runtime/ssh"]
44+
},
45+
"fork",
46+
"init-hooks"
47+
]
48+
},
49+
"vscode-extension",
50+
"models",
51+
{
52+
"group": "Keyboard Shortcuts",
53+
"pages": ["keybinds", "vim-mode"]
54+
},
55+
"context-management",
56+
"instruction-files",
57+
{
58+
"group": "Project Secrets",
59+
"pages": ["project-secrets", "agentic-git-identity"]
60+
}
61+
]
62+
},
63+
{
64+
"group": "Advanced",
65+
"pages": ["prompting-tips", "system-prompt", "telemetry", "mux-codes"]
66+
},
67+
{
68+
"group": "Development",
69+
"pages": ["storybook", "benchmarking", "AGENTS"]
70+
}
71+
]
72+
}
73+
]
74+
},
75+
"footerSocials": {
76+
"github": "https://github.com/coder/mux"
77+
}
78+
}

‎docs/favicon.svg‎

Lines changed: 4 additions & 0 deletions
Loading

‎docs/fork.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
# Forking Workspaces
1+
---
2+
title: Forking Workspaces
3+
description: Clone workspaces with conversation history to explore alternatives
4+
---
25

36
Use `/fork` to clone a workspace with its full conversation history and UI state. The forked workspace gets a new workspace on a new branch (using the same backend as the current workspace).
47

‎docs/img/dark.svg‎

Lines changed: 4 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)