Skip to content

docs: add macOS first-run prerequisites to quick start#925

Merged
cv merged 1 commit intoNVIDIA:mainfrom
WuKongAI-CMU:docs/814-macos-prereqs-r2
Mar 26, 2026
Merged

docs: add macOS first-run prerequisites to quick start#925
cv merged 1 commit intoNVIDIA:mainfrom
WuKongAI-CMU:docs/814-macos-prereqs-r2

Conversation

@WuKongAI-CMU
Copy link
Copy Markdown
Contributor

@WuKongAI-CMU WuKongAI-CMU commented Mar 25, 2026

Summary\n- add macOS first-run prerequisites to the quick start\n- document Xcode Command Line Tools, container runtime expectations, and recommended setup order\n- capture common first-run failures before the install steps\n\n## Linked issue\n- closes #814\n\nReplacement for auto-closed #905 after the contributor open-PR limit was hit.

Summary by CodeRabbit

  • Documentation
    • Added a macOS first-run checklist under Prerequisites to guide initial environment setup
    • Checklist outlines required steps: install Xcode Command Line Tools, set up a supported container runtime (Docker Desktop or Colima), then run the installer
    • Highlights common first-run issues to avoid: missing developer tools and Docker connection errors when no runtime is installed or running

Signed-off-by: peteryuqin <peter.yuqin@gmail.com>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 25, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 37334257-cd53-4751-8a6a-aef52718b443

📥 Commits

Reviewing files that changed from the base of the PR and between b42f291 and 2cbe41f.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

A new macOS first-run checklist section was added to the README prerequisites, documenting the recommended installation sequence for fresh macOS machines: install Xcode Command Line Tools, install a supported container runtime, then run the NemoClaw installer.

Changes

Cohort / File(s) Summary
macOS First-Run Setup Documentation
README.md
Added a dedicated macOS first-run checklist section under prerequisites, outlining the recommended installation order and documenting two common failure categories (missing Xcode Command Line Tools and missing container runtime).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

🐰 A checklist hops onto the page,
For Macs fresh as a blank stage,
Xcode first, then runtime too—
No more guessing what to do! 🚀

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely summarizes the main change: adding macOS first-run prerequisites documentation to the quick start guide, which matches the file change (README.md update).
Linked Issues check ✅ Passed All primary objectives from linked issues #814 and #905 are met: macOS first-run prerequisites section added to README, Xcode Command Line Tools requirement documented, supported container runtimes listed, recommended install order provided, and common first-run failures identified.
Out of Scope Changes check ✅ Passed The pull request contains only documentation changes (README.md) directly related to the linked issues; no out-of-scope code modifications or unrelated content is present.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands and usage tips.

@WuKongAI-CMU
Copy link
Copy Markdown
Contributor Author

This replacement PR is current on main and ready for human review when maintainers have a cycle. I intentionally kept it scoped to the first-run macOS prerequisites only.

Copy link
Copy Markdown
Contributor

@prekshivyas prekshivyas left a comment

Choose a reason for hiding this comment

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

Clean, accurate, well-scoped. The checklist matches the supported runtimes in the Container Runtime table and the placement after that table is natural.

One optional follow-up: adding an xcode-select troubleshooting entry to docs/reference/troubleshooting.md would round out the macOS coverage, but that's not a blocker for this PR.

@cv cv merged commit eb2fb7c into NVIDIA:main Mar 26, 2026
2 of 3 checks passed
lakamsani pushed a commit to lakamsani/NemoClaw that referenced this pull request Apr 4, 2026
Signed-off-by: peteryuqin <peter.yuqin@gmail.com>
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.

docs: improve macOS install guidance when Xcode and a container runtime are missing

3 participants