Skip to content

Commit 59be8be

Browse files
authored
🤖 fix: mintlify migration cleanup (#914)
Follow-up to #913 - cleanup after Mintlify migration. ## Changes - **Add docs link check to CI**: `make check-docs-links` runs `mintlify broken-links` as part of `static-check` - **Update docs/README.md**: Replace mdbook instructions with Mintlify workflow - **Update docs/AGENTS.md**: Reference `docs.json` instead of `SUMMARY.md`, update tooling section - **Fix .html links**: Remove `.html` suffix from all mux.coder.com links (Mintlify uses clean URLs) - README.md: 8 links fixed - src/browser/utils/commands/sources.ts: keybinds link fixed _Generated with mux_
1 parent 0f2c6d4 commit 59be8be

File tree

5 files changed

+45
-54
lines changed

5 files changed

+45
-54
lines changed

Makefile

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ include fmt.mk
4949
.PHONY: test test-unit test-integration test-watch test-coverage test-e2e smoke-test
5050
.PHONY: dist dist-mac dist-win dist-linux
5151
.PHONY: vscode-ext vscode-ext-install
52-
.PHONY: docs-server
52+
.PHONY: docs-server check-docs-links
5353
.PHONY: storybook storybook-build test-storybook chromatic
5454
.PHONY: benchmark-terminal
5555
.PHONY: ensure-deps rebuild-native
@@ -213,7 +213,7 @@ build/icon.png: docs/img/logo.webp scripts/generate-icons.ts
213213
@bun scripts/generate-icons.ts png
214214

215215
## Quality checks (can run in parallel)
216-
static-check: lint typecheck fmt-check check-eager-imports check-bench-agent ## Run all static checks
216+
static-check: lint typecheck fmt-check check-eager-imports check-bench-agent check-docs-links ## Run all static checks
217217

218218
check-bench-agent: ## Verify terminal-bench agent configuration and imports
219219
@./scripts/check-bench-agent.sh
@@ -340,6 +340,10 @@ vscode-ext-install: ## Build and install VS Code extension locally
340340
docs-server: node_modules/.installed ## Serve documentation locally (Mintlify dev server)
341341
@cd docs && npx mintlify dev
342342

343+
check-docs-links: ## Check documentation for broken links
344+
@echo "🔗 Checking documentation links..."
345+
@cd docs && npx mintlify broken-links
346+
343347
## Storybook
344348
storybook: node_modules/.installed ## Start Storybook development server
345349
$(check_node_version)

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -35,19 +35,19 @@ Here are some specific use cases we enable:
3535

3636
## Features
3737

38-
- **Isolated workspaces** with central view on git divergence ([docs](https://mux.coder.com/runtime.html))
39-
- **[Local](https://mux.coder.com/runtime/local.html)**: run directly in your project directory
40-
- **[Worktree](https://mux.coder.com/runtime/worktree.html)**: git worktrees on your local machine
41-
- **[SSH](https://mux.coder.com/runtime/ssh.html)**: remote execution on a server over SSH
38+
- **Isolated workspaces** with central view on git divergence ([docs](https://mux.coder.com/runtime))
39+
- **[Local](https://mux.coder.com/runtime/local)**: run directly in your project directory
40+
- **[Worktree](https://mux.coder.com/runtime/worktree)**: git worktrees on your local machine
41+
- **[SSH](https://mux.coder.com/runtime/ssh)**: remote execution on a server over SSH
4242
- **Multi-model** (`sonnet-4-*`, `grok-*`, `gpt-5-*`, `opus-4-*`)
43-
- Ollama supported for local LLMs ([docs](https://mux.coder.com/models.html#ollama-local))
44-
- OpenRouter supported for long-tail of LLMs ([docs](https://mux.coder.com/models.html#openrouter-cloud))
45-
- **VS Code Extension**: Jump into mux workspaces directly from VS Code ([docs](https://mux.coder.com/vscode-extension.html))
43+
- Ollama supported for local LLMs ([docs](https://mux.coder.com/models#ollama-local))
44+
- OpenRouter supported for long-tail of LLMs ([docs](https://mux.coder.com/models#openrouter-cloud))
45+
- **VS Code Extension**: Jump into mux workspaces directly from VS Code ([docs](https://mux.coder.com/vscode-extension))
4646
- Supporting UI and keybinds for efficiently managing a suite of agents
4747
- Rich markdown outputs (mermaid diagrams, LaTeX, etc.)
4848

4949
mux has a custom agent loop but much of the core UX is inspired by Claude Code. You'll find familiar features like Plan/Exec mode, vim inputs, `/compact` and new ones
50-
like [opportunistic compaction](https://mux.coder.com/context-management.html) and [mode prompts](https://mux.coder.com/instruction-files.html#mode-prompts).
50+
like [opportunistic compaction](https://mux.coder.com/context-management) and [mode prompts](https://mux.coder.com/instruction-files#mode-prompts).
5151

5252
**[Read the full documentation →](https://mux.coder.com)**
5353

@@ -60,7 +60,7 @@ like [opportunistic compaction](https://mux.coder.com/context-management.html) a
6060
Download pre-built binaries from [the releases page](https://github.com/coder/mux/releases) for
6161
macOS and Linux.
6262

63-
[More on installation →](https://mux.coder.com/install.html)
63+
[More on installation →](https://mux.coder.com/install)
6464

6565
## Screenshots
6666

docs/AGENTS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ gh pr view <number> --json mergeable,mergeStateStatus | jq '.'
3636

3737
## Documentation Rules
3838

39-
- No free-floating Markdown. User docs live in `docs/` (read `docs/README.md`, update `docs/SUMMARY.md`, 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.
4040
- For planning artifacts, use the `propose_plan` tool or inline comments instead of ad-hoc docs.
4141
- Do not add new root-level docs without explicit request; during feature work rely on code + tests + inline comments.
4242
- Test documentation stays inside the relevant test file as commentary explaining setup/edge cases.
@@ -52,7 +52,7 @@ gh pr view <number> --json mergeable,mergeStateStatus | jq '.'
5252
- Package manager: bun only. Use `bun install`, `bun add`, `bun run` (which proxies to Make when relevant). Run `bun install` if modules/types go missing.
5353
- Makefile is source of truth (new commands land there, not `package.json`).
5454
- Primary targets: `make dev|start|build|lint|lint-fix|fmt|fmt-check|typecheck|test|test-integration|clean|help`.
55-
- Full `static-check` includes docs link checking which requires mdbook tools. Use `nix develop` to get them, or the check gracefully skips if unavailable.
55+
- Full `static-check` includes docs link checking via `mintlify broken-links`.
5656

5757
## Refactoring & Runtime Etiquette
5858

docs/README.md

Lines changed: 27 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,53 @@
11
# mux Documentation
22

3-
This directory contains the source for mux documentation built with [mdbook](https://rust-lang.github.io/mdBook/).
3+
This directory contains the source for mux documentation hosted on [Mintlify](https://mintlify.com/).
44

5-
## Quick Start
5+
**Live docs:** https://mux.coder.com
66

7-
```bash
8-
# Build docs
9-
bun docs
10-
11-
# Serve docs with hot reload (opens in browser)
12-
bun docs:serve
7+
## Local Development
138

14-
# Watch for changes (no server)
15-
bun docs:watch
9+
```bash
10+
# Serve docs locally with hot reload
11+
make docs-server
1612
```
1713

1814
## Features
1915

2016
-**Mermaid diagrams** - Add diagrams with ` ```mermaid ` code blocks
21-
-**Link checking** - Automatically validates all links during build
22-
-**GitHub Pages** - Auto-deploys to https://mux.io on push to main
17+
-**Link checking** - CI validates all internal links via `mintlify broken-links`
18+
-**Auto-deploy** - Mintlify automatically deploys on push to main
2319

2420
## Structure
2521

2622
```
2723
docs/
28-
├── book.toml # mdbook configuration
29-
├── src/
30-
│ ├── SUMMARY.md # Table of contents
31-
│ └── *.md # Documentation pages
32-
└── book/ # Build output (gitignored)
24+
├── docs.json # Mintlify configuration (navigation, theme, etc.)
25+
├── custom.css # Custom styling
26+
├── img/ # Images and logos
27+
└── *.md # Documentation pages
3328
```
3429

3530
## Adding Content
3631

37-
1. Create a new `.md` file in `src/`
38-
2. Add it to `src/SUMMARY.md` to make it appear in the sidebar
39-
3. Use standard markdown + mermaid diagrams
32+
1. Create a new `.md` file in `docs/`
33+
2. Add frontmatter with title and description
34+
3. Add the page to `docs.json` navigation
35+
4. Use standard markdown + mermaid diagrams
36+
37+
Example frontmatter:
38+
39+
```markdown
40+
---
41+
title: Page Title
42+
description: Brief description for SEO
43+
---
44+
```
4045

4146
## Writing Guidelines
4247

4348
See [STYLE.md](./STYLE.md) for documentation writing guidelines.
4449

4550
## CI/CD
4651

47-
Docs are automatically built and deployed via `.github/workflows/docs.yml` when:
48-
49-
- Changes are pushed to `main` branch in the `docs/` directory
50-
- Workflow is manually triggered
51-
52-
## Requirements
53-
54-
The following tools are needed to build locally:
55-
56-
- `mdbook` (v0.4.52+)
57-
- `mdbook-mermaid` (v0.16.0+)
58-
- `mdbook-linkcheck` (v0.7.7+)
59-
- `mdbook-pagetoc` (v0.2.1+)
60-
61-
Install via cargo:
62-
63-
```bash
64-
cargo install mdbook mdbook-mermaid mdbook-linkcheck mdbook-pagetoc
65-
mdbook-mermaid install docs
66-
```
52+
- **Link checking**: CI runs `mintlify broken-links` on every PR
53+
- **Deployment**: Mintlify GitHub app auto-deploys on push to main

src/browser/utils/commands/sources.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -483,7 +483,7 @@ export function buildCoreSources(p: BuildSourcesParams): Array<() => CommandActi
483483
section: section.help,
484484
run: () => {
485485
try {
486-
window.open("https://mux.coder.com/keybinds.html", "_blank");
486+
window.open("https://mux.coder.com/keybinds", "_blank");
487487
} catch {
488488
/* ignore */
489489
}

0 commit comments

Comments
 (0)