🤖 docs: convert to .mdx and auto-generate models table #952
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Rename all docs/*.md to docs/*.mdx for consistent MDX parsing - Add scripts/gen_docs.ts to sync: - docs/models.mdx: generated table from knownModels.ts - docs/system-prompt.mdx: snippet from systemMessage.ts - Replace shell script with TypeScript for better maintainability - Update fmt.mk to run gen_docs.ts on make fmt/fmt-check - Update .prettierrc to use mdx parser for docs/*.mdx The models table now auto-updates when models change, showing: - Model display name, full ID, aliases, and default marker - Custom models can still be used via /model <provider:model_id> _Generated with `mux`_
|
Codex usage limits have been reached for code reviews. Please check with the admins of this repo to increase the limits by adding credits. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Convert all docs to
.mdxextension and add auto-generation of the models table from source code.Changes
docs/*.mdtodocs/*.mdxfor consistent MDX parsingscripts/gen_docs.ts- Bun CLI that syncs generated content:docs/models.mdx: table generated fromknownModels.tsdocs/system-prompt.mdx: snippet extracted fromsystemMessage.tsscripts/sync_system_prompt_docs.shwith TypeScript versionfmt.mkto rungen_docs.tsonmake fmt/make fmt-check.prettierrcto use MDX parser fordocs/*.mdxGenerated Models Table
The table auto-updates when models in
knownModels.tschange, showing:Custom models can still be used via
/model <provider:model_id>.Validation
make fmt-checkpassesmintlify broken-linkspassesGenerated with
mux