Update links to MLX packages in documentation #277
Merged
+20
−42
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
|
For your consideration: The current use of "Other MLX Packages" is a misnomer. In Swift Package Manager terms, |
davidkoski
approved these changes
Sep 29, 2025
|
Hrm, swift-format fails but it is an .md only change ... |
|
Ah, I see. mlx-swift hasn't been updated since the 602 swift-format came out so there are lingering changes required. I will take care of that in another PR, maybe #273 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Currently, the top-level documentation for modules includes an "Other MLX Packages" section with self-links and links to deprecated frameworks.
For example, here's the landing page for MLXNN as it appears on Swift Package Index:
This PR removes all self-links (e.g. linking to
MLXNNon the landing page forMLXNN) and links to deprecated frameworks. This will help prevent new users from navigating to the docs and being confused about the extent of modules available in the MLX package. This PR also updatesMAINTENANCE.md, but I'm less confident in that change.