Skip to content

Commit 3fe4716

Browse files
authored
🤖 docs: convert to .mdx and auto-generate models table (#952)
## Summary Convert all docs to `.mdx` extension and add auto-generation of the models table from source code. ## Changes - **Rename all `docs/*.md` to `docs/*.mdx`** for consistent MDX parsing - **Add `scripts/gen_docs.ts`** - Bun CLI that syncs generated content: - `docs/models.mdx`: table generated from `knownModels.ts` - `docs/system-prompt.mdx`: snippet extracted from `systemMessage.ts` - **Replace `scripts/sync_system_prompt_docs.sh`** with TypeScript version - **Update `fmt.mk`** to run `gen_docs.ts` on `make fmt`/`make fmt-check` - **Update `.prettierrc`** to use MDX parser for `docs/*.mdx` ## Generated Models Table The table auto-updates when models in `knownModels.ts` change, showing: - Model display name - Full ID (provider:model) - Aliases for quick switching - Default marker Custom models can still be used via `/model <provider:model_id>`. ## Validation - `make fmt-check` passes - `mintlify broken-links` passes _Generated with `mux`_
1 parent 66e5bc8 commit 3fe4716

29 files changed

+261
-76
lines changed

.prettierrc

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,13 @@
88
"printWidth": 100,
99
"bracketSpacing": true,
1010
"arrowParens": "always",
11-
"endOfLine": "lf"
11+
"endOfLine": "lf",
12+
"overrides": [
13+
{
14+
"files": "docs/**/*.mdx",
15+
"options": {
16+
"parser": "mdx"
17+
}
18+
}
19+
]
1220
}
Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,9 @@ Create a separate GitHub account for your agent:
2626
2. Use a distinctive username (e.g., `yourname-agent`, `yourname-ai`)
2727
3. Use a separate email (GitHub allows plus-addressing: `yourname+ai@example.com`)
2828

29-
<Info>This is optional but recommended. You can also use your main account with a different email/name.</Info>
29+
<Info>
30+
This is optional but recommended. You can also use your main account with a different email/name.
31+
</Info>
3032

3133
## Step 2: Generate Classic GitHub Token
3234

@@ -57,7 +59,10 @@ Add the Git identity environment variables as [Project Secrets](/project-secrets
5759

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

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>
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>
6166

6267
## Step 4: Configure GitHub Authentication
6368

@@ -101,4 +106,7 @@ git config --global credential.helper ""
101106
git config --global --add credential.helper '!gh auth git-credential'
102107
```
103108

104-
<Warning>The "replace all" approach will disable platform keychain helpers and may break Git authentication for non-GitHub remotes (GitLab, Bitbucket, etc.).</Warning>
109+
<Warning>
110+
The "replace all" approach will disable platform keychain helpers and may break Git authentication
111+
for non-GitHub remotes (GitLab, Bitbucket, etc.).
112+
</Warning>
File renamed without changes.
File renamed without changes.
Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,9 @@ Remove oldest 50% of messages.
152152

153153
### OpenAI Responses API Limitation
154154

155-
<Warning>`/truncate` does not work with OpenAI models due to the Responses API architecture:</Warning>
155+
<Warning>
156+
`/truncate` does not work with OpenAI models due to the Responses API architecture:
157+
</Warning>
156158

157159
- OpenAI's Responses API stores conversation state server-side
158160
- Manual message deletion via `/truncate` doesn't affect the server-side state
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/install.md renamed to docs/install.mdx

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,10 @@ Download pre-built binaries of `main` from [GitHub Actions](https://github.com/c
2222
- `macos-dmg-arm64` (Apple Silicon)
2323
- **Linux**: AppImage (portable, works on most distros)
2424

25-
<Info>Windows builds are only available from [releases](https://github.com/coder/mux/releases), not from development builds.</Info>
25+
<Info>
26+
Windows builds are only available from [releases](https://github.com/coder/mux/releases), not from
27+
development builds.
28+
</Info>
2629

2730
To download:
2831

@@ -57,11 +60,17 @@ The app is code-signed and notarized by Apple, so it will open without security
5760
3. Follow the installation prompts
5861
4. Launch Mux from the Start menu or desktop shortcut
5962

60-
<Warning>Windows support is currently in alpha. Please [report any issues](https://github.com/coder/mux/issues) you encounter.</Warning>
63+
<Warning>
64+
Windows support is currently in alpha. Please [report any
65+
issues](https://github.com/coder/mux/issues) you encounter.
66+
</Warning>
6167

6268
### Testing Pre-Release Builds
6369

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>
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>
6574

6675
1. After installing, open Terminal
6776
2. Run: `xattr -cr /Applications/Mux.app`
File renamed without changes.

0 commit comments

Comments
 (0)