Skip to content

Add llama.cpp and MLX docs to Advanced section, add Convert to MLX guide#201

Open
kaydenlms wants to merge 6 commits intomainfrom
kayden/docs-additions
Open

Add llama.cpp and MLX docs to Advanced section, add Convert to MLX guide#201
kaydenlms wants to merge 6 commits intomainfrom
kayden/docs-additions

Conversation

@kaydenlms
Copy link
Copy Markdown
Collaborator

@kaydenlms kaydenlms commented Mar 30, 2026

Summary

  • Add llama.cpp and MLX runtime documentation pages under the Advanced section
  • Add Convert to MLX guide (hidden with underscore prefix for now)
  • Update internal link references

Test plan

  • Verify llama-cpp.md and mlx.md render correctly under Advanced
  • Verify _convert-to-mlx.md is hidden from navigation
  • Check all internal links resolve correctly

🤖 Generated with Claude Code

kaydenlms and others added 2 commits March 30, 2026 12:48
… guide

- Add new Runtimes section between Getting Started and MCP with pages
  for llama.cpp and MLX runtimes
- Add Convert Models to MLX page under modelyaml section
- Renumber existing sections to accommodate new Runtimes section

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@github-actions github-actions bot added the CLA signed Indicates that all contributors have signed label Mar 30, 2026
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: d54585918d

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

- Add line continuations for multi-line commands
- Replace unicode en-dash with ASCII hyphens in --mlx-path flag

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…onvert-to-mlx

- Remove 2_runtimes section entirely
- Move llama-cpp.md and mlx.md under 6_advanced
- Rename convert-to-mlx.md to _convert-to-mlx.md to hide article
- Update internal link reference from runtimes/mlx to advanced/mlx

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@kaydenlms kaydenlms changed the title Add Runtimes section and Convert to MLX guide Add llama.cpp and MLX docs to Advanced section, add Convert to MLX guide Apr 7, 2026
kaydenlms and others added 2 commits April 7, 2026 15:28
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@kaydenlms kaydenlms requested a review from rugvedS07 April 7, 2026 19:31
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: b3a6cdeb44

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".


Many popular models already have MLX versions available. Before converting manually, check out [lmstudio-community](https://huggingface.co/lmstudio-community) or [mlx-community](https://huggingface.co/mlx-community) on HuggingFace to see if the model you want is available in MLX format.

Models stored locally in other formats can be converted to MLX format to use with the MLX engine. See our guide on [converting models to MLX format](../modelyaml/convert-to-mlx).
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Remove link to ignored underscore doc

This link points to ../modelyaml/convert-to-mlx, but the only target introduced in this commit is 0_app/4_modelyaml/_convert-to-mlx.md, and this repo’s parser explicitly ignores files that start with _ (README parsing rules). As a result, users following this link from the MLX page will hit a missing page until the guide is published under a non-underscored filename or the link is removed.

Useful? React with 👍 / 👎.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA signed Indicates that all contributors have signed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants