Skip to content

docs: feature setup command as primary onboarding in README#33

Merged
weklund merged 1 commit intomainfrom
docs/readme-setup-command
Apr 4, 2026
Merged

docs: feature setup command as primary onboarding in README#33
weklund merged 1 commit intomainfrom
docs/readme-setup-command

Conversation

@weklund
Copy link
Copy Markdown
Owner

@weklund weklund commented Apr 4, 2026

Summary

  • Lead the hero snippet and Quick Start with mlx-stack setup instead of the manual initpullup flow
  • Add setup to the CLI Reference with its three options (--accept-defaults, --intent, --budget-pct)
  • Move the manual 5-step flow into a collapsible <details> block for users who want full control
  • Update 24/7 Operation quick setup to use setup --accept-defaults
  • Update Development section to reference make check / make lint instead of raw commands

Test plan

  • No code changes — documentation only
  • Verified mlx-stack setup command exists at src/mlx_stack/cli/setup.py with the documented options

🤖 Generated with Claude Code

The interactive `mlx-stack setup` command walks through hardware detection,
model selection, downloading, and stack startup in one guided flow — but it
was completely missing from the README. Now it leads the Quick Start and
CLI Reference sections, with the manual step-by-step flow in a collapsible
details block.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@weklund weklund merged commit 1f60c05 into main Apr 4, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant