Skip to content

v2.3.0 — First-run Onboarding Guidance Design

Choose a tag to compare

View all tags
@acari-git acari-git released this 15 Jun 11:42
· 7 commits to main since this release
v2.3.0
5e78687

v2.3.0

This is a docs-only release.

Summary

v2.3.0 adds the onboarding and first-run guidance design for new MLX Server Manager users.

The goal is to make the first setup flow clearer, especially around mlx_lm.server executable paths, model profiles, readiness checks, connection settings, and the difference between managed and external server workflows.

No app code was changed in this release.

Added

  • Added docs/onboarding_first_run.md
  • Added onboarding / first-run guidance link to README
  • Added future onboarding verification notes to docs/testing.md
  • Updated task notes for v2.3.0

First-run Guidance Covers

The new design document covers:

  • first-run checklist
  • required setup
  • recommended first launch flow
  • managed server flow
  • external server flow
  • Connection Settings flow
  • Hermes Agent setup flow
  • troubleshooting prompts
  • UI copy suggestions
  • safety and privacy notes
  • testing plan
  • future work

Key First-run Concepts

The guidance explains:

  • how to set the mlx_lm.server executable path
  • how to confirm the selected model profile
  • how host and port are used
  • why readiness uses /v1/models
  • what to copy for OpenAI-compatible clients
  • how Hermes Agent configuration fits into Direct Mode
  • how managed server and adopted external server workflows differ
  • why the app does not proxy inference requests

Direct Mode Boundary

Direct Mode remains unchanged:

OpenAI-compatible client -> mlx_lm.server or adopted external server -> MLX model

MLX Server Manager does not proxy inference requests, act as a chat UI, or become a multi-backend wrapper.

Ownership Boundary

The guidance keeps the ownership boundary clear:

  • Managed Server is started and controlled by MLX Server Manager
  • External Server Detected is not app-managed
  • Adopted External Server is connection context only
  • Stop / Restart applies only to app-managed processes
  • External servers are not stopped, restarted, killed, monitored, or log-collected by MLX Server Manager

Not Changed

  • No Swift changes
  • No Xcode project changes
  • No build setting changes
  • No new app binary
  • No new zip asset
  • No inference proxy
  • No chat UI
  • No multi-backend wrapper
  • No external process ownership changes

Current Binary Asset

The current downloadable app binary remains the v1.9.0 unsigned build:

MLXServerManager-v1.9.0-unsigned.zip

This v2.3.0 release does not include a new binary asset.

Assets 2
Loading