Skip to content

Commit dd87667

Browse files
committed
🤖 fix: complete mintlify migration
- Remove mdbook workflow (.github/workflows/docs.yml) - Remove mdbook-specific files (book.toml, SUMMARY.md) - Remove mdbook build scripts (docs_build.sh, docs.sh) - Update Makefile docs targets for Mintlify - Fix formatting issues in docs _Generated with mux_
1 parent ce063e4 commit dd87667

File tree

10 files changed

+13
-233
lines changed

10 files changed

+13
-233
lines changed

.github/workflows/docs.yml

Lines changed: 0 additions & 108 deletions
This file was deleted.

Makefile

Lines changed: 6 additions & 18 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 docs-server docs-watch check-docs-links
52+
.PHONY: docs docs-server
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 check-docs-links ## Run all static checks (includes startup performance checks)
216+
static-check: lint typecheck fmt-check check-eager-imports check-bench-agent ## Run all static checks
217217

218218
check-bench-agent: ## Verify terminal-bench agent configuration and imports
219219
@./scripts/check-bench-agent.sh
@@ -337,23 +337,11 @@ vscode-ext-install: ## Build and install VS Code extension locally
337337
@$(MAKE) -C vscode install
338338

339339
## Documentation
340-
docs: ## Build documentation
341-
@./scripts/docs_build.sh
340+
docs: ## Build documentation (Mintlify)
341+
@cd docs && npx mintlify build
342342

343-
docs-server: ## Serve documentation locally (opens browser)
344-
@./scripts/docs.sh
345-
346-
docs-watch: ## Watch and rebuild documentation
347-
@cd docs && mdbook watch
348-
349-
check-docs-links: ## Check documentation for broken links (requires mdbook tools via nix)
350-
@if command -v mdbook >/dev/null 2>&1 && command -v mdbook-linkcheck >/dev/null 2>&1; then \
351-
$(MAKE) docs && \
352-
echo "🔗 Checking documentation links..." && \
353-
cd docs && mdbook-linkcheck --standalone .; \
354-
else \
355-
echo "⏭️ Skipping docs link check (mdbook tools not installed - use 'nix develop' for full checks)"; \
356-
fi
343+
docs-server: node_modules/.installed ## Serve documentation locally (opens browser)
344+
@cd docs && npx mintlify dev
357345

358346
## Storybook
359347
storybook: node_modules/.installed ## Start Storybook development server

docs/AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ Avoid mock-heavy tests that verify implementation details rather than behavior.
156156
- Prefer fixes that simplify existing code; such simplifications often do not need new tests.
157157
- When adding complexity, add or extend tests. If coverage requires new infrastructure, propose the harness and then add the tests there.
158158

159-
{/* 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. _/}
160160

161161
## Mode: Exec
162162

docs/SUMMARY.md

Lines changed: 0 additions & 39 deletions
This file was deleted.

docs/book.toml

Lines changed: 0 additions & 35 deletions
This file was deleted.

docs/mux-codes.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ title: Mux Codes
33
description: Redeem free LLM token credits for evaluating Mux
44
---
55

6-
76
Mux codes are free LLM token credits for evaluating Mux. Coder employees disburse them at events to users we think will enjoy Mux. If you want to get your hands on a code, ask the nearest Coder employee.
87

98
A code looks like `ABC-123`.

docs/system-prompt.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: System Prompt
33
description: How mux constructs the system prompt for AI models
44
---
55

6+
# System Prompt
7+
68
`mux` is interested in supporting a variety of models at different levels of performance.
79

810
To that end, we're built on the [Vercel AI SDK](https://ai-sdk.dev/providers/ai-sdk-providers) which does most of the heavy lifting in creating a unified API for all models.
@@ -11,7 +13,7 @@ Even with consistent support at the protocol layer, we have found that different
1113

1214
Here's a snippet from `src/node/services/systemMessage.ts` which is our shared system prompt (minus tools).
1315

14-
{/* BEGIN SYSTEM_PROMPT_DOCS */}
16+
<!-- BEGIN SYSTEM_PROMPT_DOCS -->
1517

1618
```typescript
1719
// The PRELUDE is intentionally minimal to not conflict with the user's instructions.
@@ -59,4 +61,4 @@ You are in a git worktree at ${workspacePath}
5961
}
6062
```
6163

62-
{/* END SYSTEM_PROMPT_DOCS */}
64+
<!-- END SYSTEM_PROMPT_DOCS -->

docs/vim-mode.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,8 @@ title: Vim Mode
33
description: Vim-style editing in the mux chat input
44
---
55

6-
{/* Keep this file in sync with:
7-
- src/components/VimTextArea.tsx (implementation)
8-
- src/utils/vim.ts (core logic)
9-
- src/utils/vim.test.ts (test suite)
10-
*/}
6+
{/_ Keep this file in sync with: - src/components/VimTextArea.tsx (implementation) - src/utils/vim.ts (core logic) - src/utils/vim.test.ts (test suite)
7+
_/}
118

129
mux includes a built-in Vim mode for the chat input, providing familiar Vim-style editing for power users.
1310

scripts/docs.sh

Lines changed: 0 additions & 12 deletions
This file was deleted.

scripts/docs_build.sh

Lines changed: 0 additions & 12 deletions
This file was deleted.

0 commit comments

Comments
 (0)