Commit 3fe4716
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
File tree
29 files changed
+261
-76
lines changed- docs
- runtime
- scripts
29 files changed
+261
-76
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
11 | | - | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
12 | 20 | | |
Lines changed: 11 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
26 | 26 | | |
27 | 27 | | |
28 | 28 | | |
29 | | - | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
30 | 32 | | |
31 | 33 | | |
32 | 34 | | |
| |||
57 | 59 | | |
58 | 60 | | |
59 | 61 | | |
60 | | - | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
61 | 66 | | |
62 | 67 | | |
63 | 68 | | |
| |||
101 | 106 | | |
102 | 107 | | |
103 | 108 | | |
104 | | - | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
File renamed without changes.
File renamed without changes.
Lines changed: 3 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
152 | 152 | | |
153 | 153 | | |
154 | 154 | | |
155 | | - | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
156 | 158 | | |
157 | 159 | | |
158 | 160 | | |
| |||
File renamed without changes.
File renamed without changes.
File renamed without changes.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
22 | 22 | | |
23 | 23 | | |
24 | 24 | | |
25 | | - | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
26 | 29 | | |
27 | 30 | | |
28 | 31 | | |
| |||
57 | 60 | | |
58 | 61 | | |
59 | 62 | | |
60 | | - | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
61 | 67 | | |
62 | 68 | | |
63 | 69 | | |
64 | | - | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
65 | 74 | | |
66 | 75 | | |
67 | 76 | | |
| |||
File renamed without changes.
0 commit comments