You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- No free-floating Markdown. User docs live in `docs/` (read `docs/README.mdx`, add pages to `docs.json` navigation, use standard Markdown + mermaid). Developer/test notes belong inline as comments.
39
+
- No free-floating Markdown. User docs live in `docs/` (read `docs/README.md`, add pages to `docs.json` navigation, use standard Markdown + mermaid). Developer/test notes belong inline as comments.
40
40
- For planning artifacts, use the `propose_plan` tool or inline comments instead of ad-hoc docs.
41
41
- Do not add new root-level docs without explicit request; during feature work rely on code + tests + inline comments.
42
42
- Test documentation stays inside the relevant test file as commentary explaining setup/edge cases.
@@ -168,10 +168,6 @@ Avoid mock-heavy tests that verify implementation details rather than behavior.
168
168
- When Plan Mode is requested, assume the user wants the actual completed plan; do not merely describe how you would devise one.
169
169
- Attach a net LoC estimate (product code only) to each recommended approach.
170
170
171
-
## Model: openai.\*
172
-
173
-
- Use the `gh` CLI for GitHub operations (e.g., opening/submitting PRs).
Copy file name to clipboardExpand all lines: docs/agentic-git-identity.md
+3-11Lines changed: 3 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,9 +26,7 @@ Create a separate GitHub account for your agent:
26
26
2. Use a distinctive username (e.g., `yourname-agent`, `yourname-ai`)
27
27
3. Use a separate email (GitHub allows plus-addressing: `yourname+ai@example.com`)
28
28
29
-
<Info>
30
-
This is optional but recommended. You can also use your main account with a different email/name.
31
-
</Info>
29
+
<Info>This is optional but recommended. You can also use your main account with a different email/name.</Info>
32
30
33
31
## Step 2: Generate Classic GitHub Token
34
32
@@ -59,10 +57,7 @@ Add the Git identity environment variables as [Project Secrets](/project-secrets
59
57
60
58
These environment variables will be automatically injected when the agent runs Git commands in that project.
61
59
62
-
<Info>
63
-
If you need the agent identity outside of mux, you can alternatively set these as global
64
-
environment variables in your shell configuration (`~/.zshrc`, `~/.bashrc`, etc.)
65
-
</Info>
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>
The "replace all" approach will disable platform keychain helpers and may break Git authentication
111
-
for non-GitHub remotes (GitLab, Bitbucket, etc.).
112
-
</Warning>
104
+
<Warning>The "replace all" approach will disable platform keychain helpers and may break Git authentication for non-GitHub remotes (GitLab, Bitbucket, etc.).</Warning>
Copy file name to clipboardExpand all lines: docs/install.md
+3-12Lines changed: 3 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,10 +22,7 @@ Download pre-built binaries of `main` from [GitHub Actions](https://github.com/c
22
22
-`macos-dmg-arm64` (Apple Silicon)
23
23
-**Linux**: AppImage (portable, works on most distros)
24
24
25
-
<Info>
26
-
Windows builds are only available from [releases](https://github.com/coder/mux/releases), not from
27
-
development builds.
28
-
</Info>
25
+
<Info>Windows builds are only available from [releases](https://github.com/coder/mux/releases), not from development builds.</Info>
29
26
30
27
To download:
31
28
@@ -60,17 +57,11 @@ The app is code-signed and notarized by Apple, so it will open without security
60
57
3. Follow the installation prompts
61
58
4. Launch Mux from the Start menu or desktop shortcut
62
59
63
-
<Warning>
64
-
Windows support is currently in alpha. Please [report any
65
-
issues](https://github.com/coder/mux/issues) you encounter.
66
-
</Warning>
60
+
<Warning>Windows support is currently in alpha. Please [report any issues](https://github.com/coder/mux/issues) you encounter.</Warning>
67
61
68
62
### Testing Pre-Release Builds
69
63
70
-
<Warning>
71
-
Only builds from the `main` branch are signed and notarized. If you're testing a build from a pull
72
-
request or other branch, you'll need to bypass macOS Gatekeeper:
73
-
</Warning>
64
+
<Warning>Only builds from the `main` branch are signed and notarized. If you're testing a build from a pull request or other branch, you'll need to bypass macOS Gatekeeper:</Warning>
Copy file name to clipboardExpand all lines: docs/models.md
-22Lines changed: 0 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,28 +9,6 @@ See also:
9
9
10
10
mux supports multiple AI providers through its flexible provider architecture.
11
11
12
-
### First-class models
13
-
14
-
mux ships with a curated set of first-class models that we keep up to date with the frontier. You can also use any custom model from a supported provider with `/model <provider:model_id>`.
Copy file name to clipboardExpand all lines: docs/runtime/local.md
+3-9Lines changed: 3 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,15 +13,9 @@ Local runtime runs the agent directly in your project directory—the same direc
13
13
14
14
## Caveats
15
15
16
-
<Warning>
17
-
**No isolation**: Multiple local workspaces for the same project see and modify the same files.
18
-
Running them simultaneously can cause conflicts. mux shows a warning when another local workspace
19
-
is actively streaming.
20
-
</Warning>
21
-
22
-
<Warning>
23
-
**Affects your working copy**: Agent changes happen in your actual project directory.
24
-
</Warning>
16
+
<Warning>**No isolation**: Multiple local workspaces for the same project see and modify the same files. Running them simultaneously can cause conflicts. mux shows a warning when another local workspace is actively streaming.</Warning>
17
+
18
+
<Warning>**Affects your working copy**: Agent changes happen in your actual project directory.</Warning>
0 commit comments