docs: improve macOS install guidance for Xcode and container runtimes (#814)#838
Closed
ksapru wants to merge 6 commits intoNVIDIA:mainfrom
Closed
docs: improve macOS install guidance for Xcode and container runtimes (#814)#838ksapru wants to merge 6 commits intoNVIDIA:mainfrom
ksapru wants to merge 6 commits intoNVIDIA:mainfrom
Conversation
Contributor
📝 WalkthroughWalkthroughAdded a new macOS Get Started/install guide, updated README macOS prerequisite entry to reference it, and added a macOS Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 5
🧹 Nitpick comments (4)
docs/reference/troubleshooting.md (2)
205-205: Keep one sentence per source line.This line contains two sentences; please split them across two lines.
As per coding guidelines, "One sentence per line in source (makes diffs readable)."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/reference/troubleshooting.md` at line 205, The sentence in the troubleshooting entry "If your issue is not listed here, join the [NemoClaw Discord channel](...) to ask questions and get help from the community. You can also [file an issue on GitHub](...)." contains two sentences on one source line; split it into two source lines so each sentence is on its own line (i.e., keep the first sentence beginning "If your issue is not listed here..." on one line and move the second sentence "You can also [file an issue on GitHub](...)." to the next line) to comply with the "one sentence per line" guideline.
197-198: Remove bold emphasis from routine step labels (LLM pattern detected).The bolded "Install tools" and "Reset path" are routine instructions; plain text is preferred here.
As per coding guidelines, "Unnecessary bold on routine instructions ... should be flagged. Bold is reserved for UI labels, parameter names, and genuine warnings."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/reference/troubleshooting.md` around lines 197 - 198, Remove the bold formatting from the routine step labels "Install tools" and "Reset path" so they appear as plain text (e.g., change **Install tools:** to Install tools: and **Reset path:** to Reset path:), leaving the inline code snippets (`xcode-select --install`, `sudo xcode-select --reset`) unchanged; update the lines that contain those two labels in the same block to use plain text labels instead of bold.docs/get-started/install-macos.md (2)
48-48: Remove numbering from section titles.Please rename these headings without numeric prefixes.
As per coding guidelines, "Do not number section titles. Flag 'Section 1: ...', 'Step 3: ...', etc."
Also applies to: 60-60, 71-71, 81-81
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/get-started/install-macos.md` at line 48, Remove numeric prefixes from the section headings that use the "### N. ..." pattern (e.g., change "### 1. Install Xcode Command Line Tools" to "### Install Xcode Command Line Tools") and do the same for the other numbered headings referenced (the other "### N. ..." headings in the file); ensure only the numeric prefix and following period+space are removed so the rest of the heading text remains unchanged.
58-58: Use present tense instead of future tense."A software update popup will appear." should be rewritten in present tense.
As per coding guidelines, "Present tense. Flag future tense ('will') in descriptions of current behavior."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/get-started/install-macos.md` at line 58, The sentence "A software update popup will appear." uses future tense; change it to present tense by rewriting it as "A software update popup appears." and similarly ensure the following instruction "Click **Install** and wait for the process to complete." remains in present tense to match; update the line in docs/get-started/install-macos.md replacing "will appear" with "appears" so the description uses present-tense behavior.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/get-started/install-macos.md`:
- Line 3: The H1 heading must exactly match the frontmatter key title.page;
locate the frontmatter entry titled "title.page" and the top-level H1 in
install-macos.md and make them identical (either change the H1 to match
title.page or update title.page to match the existing H1), ensuring exact
casing, punctuation and spacing; also check the other occurrence noted (line 21)
and apply the same synchronization rule so every H1 equals its title.page
frontmatter.
- Around line 89-108: The page docs/get-started/install-macos.md currently ends
after "Troubleshooting Common macOS Issues" and lacks the required navigation;
add a final section titled "## Next Steps" at the bottom that links to the
relevant pages (for example the Get Started index, the Troubleshooting guide
../reference/troubleshooting.md, and other platform install pages) so readers
have clear related navigation; ensure the header text matches "Next Steps" and
include 3–4 anchor links with short descriptions consistent with other docs
pages.
- Around line 37-38: Fix markdownlint spacing: ensure there's exactly one space
after each list marker for the items starting with "Xcode Command Line Tools"
and "Container Runtime" (replace "**Xcode Command Line Tools:**" with "- Xcode
Command Line Tools: ..." style spacing) and add a blank line before and after
any fenced code blocks to satisfy MD030/MD031; run markdownlint (or apply the
project's styling rules) to the nearby sections referenced (the other similar
list entries and fenced blocks) so all list-marker spacing and fenced-block
spacing warnings are resolved.
- Around line 54-56: Replace the fenced code blocks that currently use the
bash/shell language tag with the console tag and prefix each CLI line with a
dollar prompt; specifically update the block containing the command
"xcode-select --install" (and the other CLI snippets in this document) by
changing the opening triple backtick from ```bash/```shell to ```console and
adding "$ " before the command text so the example reads like "$ xcode-select
--install". Ensure all remaining CLI examples in the file follow the same
pattern.
In `@docs/reference/troubleshooting.md`:
- Around line 202-206: Replace the existing admonition block titled "Get Help"
that currently uses ":::{admonition}" with the canonical MyST admonition syntax
by converting it to "::: {tip}" (i.e., use ":::{tip}" with the same title "Get
Help" and preserved links and content); ensure the admonition opening and
closing markers match MyST style and that the class attribute is removed so the
block becomes a proper tip admonition consistent with other docs.
---
Nitpick comments:
In `@docs/get-started/install-macos.md`:
- Line 48: Remove numeric prefixes from the section headings that use the "###
N. ..." pattern (e.g., change "### 1. Install Xcode Command Line Tools" to "###
Install Xcode Command Line Tools") and do the same for the other numbered
headings referenced (the other "### N. ..." headings in the file); ensure only
the numeric prefix and following period+space are removed so the rest of the
heading text remains unchanged.
- Line 58: The sentence "A software update popup will appear." uses future
tense; change it to present tense by rewriting it as "A software update popup
appears." and similarly ensure the following instruction "Click **Install** and
wait for the process to complete." remains in present tense to match; update the
line in docs/get-started/install-macos.md replacing "will appear" with "appears"
so the description uses present-tense behavior.
In `@docs/reference/troubleshooting.md`:
- Line 205: The sentence in the troubleshooting entry "If your issue is not
listed here, join the [NemoClaw Discord channel](...) to ask questions and get
help from the community. You can also [file an issue on GitHub](...)." contains
two sentences on one source line; split it into two source lines so each
sentence is on its own line (i.e., keep the first sentence beginning "If your
issue is not listed here..." on one line and move the second sentence "You can
also [file an issue on GitHub](...)." to the next line) to comply with the "one
sentence per line" guideline.
- Around line 197-198: Remove the bold formatting from the routine step labels
"Install tools" and "Reset path" so they appear as plain text (e.g., change
**Install tools:** to Install tools: and **Reset path:** to Reset path:),
leaving the inline code snippets (`xcode-select --install`, `sudo xcode-select
--reset`) unchanged; update the lines that contain those two labels in the same
block to use plain text labels instead of bold.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 0cbfa5fa-cb7e-49c5-ac06-47fad2fe2b25
📒 Files selected for processing (3)
README.mddocs/get-started/install-macos.mddocs/reference/troubleshooting.md
Contributor
There was a problem hiding this comment.
♻️ Duplicate comments (1)
docs/get-started/install-macos.md (1)
65-69:⚠️ Potential issue | 🟡 MinorAdd blank lines around the fenced code block inside the list item.
This block still trips fence-spacing lint in list context. Insert blank lines before/after the fence under the
Colimabullet.As per coding guidelines, "Review every docs change against the style guide below. Flag violations inline as review comments."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/get-started/install-macos.md` around lines 65 - 69, The fenced code block under the "Colima" list item violates fence-spacing lint; edit the docs/get-started/install-macos.md entry for the Colima bullet and insert a blank line immediately before the opening ```console fence and a blank line immediately after the closing ``` fence so the code block is separated from the list text; ensure you only adjust spacing around that fenced block (the "Colima" bullet) and do not change other content.
🧹 Nitpick comments (4)
docs/get-started/install-macos.md (4)
48-48: Remove numbering from section headings.These H3 titles are numbered, which conflicts with the docs heading rule. Use plain titles without numeric prefixes.
As per coding guidelines, "Do not number section titles. Flag 'Section 1: ...', 'Step 3: ...', etc."
Also applies to: 60-60, 71-71, 81-81
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/get-started/install-macos.md` at line 48, Remove numeric prefixes from the H3 headings so they use plain titles; for example change "### 1. Install Xcode Command Line Tools" (and the other numbered H3s at the referenced locations) to "### Install Xcode Command Line Tools" (and similarly remove "2.", "3.", etc. from the other H3 headings) to comply with the docs heading rule.
64-64: Avoid bold emphasis in routine instruction text (LLM pattern detected).The bolded phrase is routine guidance, not a UI label or warning, so it should be plain text.
As per coding guidelines, "Unnecessary bold on routine instructions ... Bold is reserved for UI labels, parameter names, and genuine warnings."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/get-started/install-macos.md` at line 64, Remove the unnecessary bolding around the routine guidance phrase in the sentence that currently reads "**ensure the application is running**" so it becomes plain text; update the line in the install instructions (the Docker Desktop bullet) to use normal text for "ensure the application is running" instead of bold, keeping bold reserved only for UI labels, parameter names, or warnings.
58-58: Use present tense for expected installer behavior.The sentence uses future tense ("will appear"). Prefer present tense in docs instructions.
As per coding guidelines, "Present tense. Flag future tense ('will') in descriptions of current behavior."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/get-started/install-macos.md` at line 58, The sentence uses future tense ("A software update popup will appear.")—change it to present tense to match docs guidelines; replace that clause with a present-tense phrasing such as "A software update popup appears." and keep the rest ("Click **Install** and wait for the process to complete.") so the full line reads like "A software update popup appears. Click **Install** and wait for the process to complete." This targets the exact sentence "A software update popup will appear." in the install-macos content.
29-29: Add a short intro sentence at the start of each section.These sections begin immediately with lists/subsections. Add a one-sentence intro under each heading for consistency.
As per coding guidelines, "Sections use H2 and H3, each starting with an introductory sentence."
Also applies to: 35-35, 89-89, 110-110
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/get-started/install-macos.md` at line 29, Add a one-sentence introductory line directly under each H2/H3 heading so the section opens with a brief description of what it covers; specifically add such an intro under the "Hardware" heading and do the same for the other flagged headings in this document (each H2/H3 should start with a short sentence), ensuring the sentence is concise and describes the section scope before the lists/subsections that follow.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@docs/get-started/install-macos.md`:
- Around line 65-69: The fenced code block under the "Colima" list item violates
fence-spacing lint; edit the docs/get-started/install-macos.md entry for the
Colima bullet and insert a blank line immediately before the opening ```console
fence and a blank line immediately after the closing ``` fence so the code block
is separated from the list text; ensure you only adjust spacing around that
fenced block (the "Colima" bullet) and do not change other content.
---
Nitpick comments:
In `@docs/get-started/install-macos.md`:
- Line 48: Remove numeric prefixes from the H3 headings so they use plain
titles; for example change "### 1. Install Xcode Command Line Tools" (and the
other numbered H3s at the referenced locations) to "### Install Xcode Command
Line Tools" (and similarly remove "2.", "3.", etc. from the other H3 headings)
to comply with the docs heading rule.
- Line 64: Remove the unnecessary bolding around the routine guidance phrase in
the sentence that currently reads "**ensure the application is running**" so it
becomes plain text; update the line in the install instructions (the Docker
Desktop bullet) to use normal text for "ensure the application is running"
instead of bold, keeping bold reserved only for UI labels, parameter names, or
warnings.
- Line 58: The sentence uses future tense ("A software update popup will
appear.")—change it to present tense to match docs guidelines; replace that
clause with a present-tense phrasing such as "A software update popup appears."
and keep the rest ("Click **Install** and wait for the process to complete.") so
the full line reads like "A software update popup appears. Click **Install** and
wait for the process to complete." This targets the exact sentence "A software
update popup will appear." in the install-macos content.
- Line 29: Add a one-sentence introductory line directly under each H2/H3
heading so the section opens with a brief description of what it covers;
specifically add such an intro under the "Hardware" heading and do the same for
the other flagged headings in this document (each H2/H3 should start with a
short sentence), ensuring the sentence is concise and describes the section
scope before the lists/subsections that follow.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: fc775e6d-fb6a-4cbe-b6e7-a7e2ba0e8ddc
📒 Files selected for processing (2)
docs/get-started/install-macos.mddocs/reference/troubleshooting.md
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/reference/troubleshooting.md
Contributor
|
Please do not override the PR description template, which gives you a quick list of things to self-check before getting reviewers eyes. |
ksapru
force-pushed
the
macos-install-guide
branch
from
e0fe4cd to
124dfb4
Compare
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (4)
docs/get-started/install-macos.md (4)
64-64: Remove unnecessary bold on routine instruction.The bold formatting on "ensure the application is running" is not necessary. Bold should be reserved for UI labels, parameter names, and genuine warnings, not routine instructions.
Suggested revision
-- **Docker Desktop:** Download from the [official site](https://www.docker.com/products/docker-desktop/), install, and **ensure the application is running**. +- **Docker Desktop:** Download from the [official site](https://www.docker.com/products/docker-desktop/), install, and ensure the application is running.As per coding guidelines, "Unnecessary bold on routine instructions ... Bold is reserved for UI labels, parameter names, and genuine warnings." LLM pattern detected.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/get-started/install-macos.md` at line 64, Remove the unnecessary bolding around the routine instruction "ensure the application is running" in the Docker Desktop bullet (the line containing "**Docker Desktop:** Download from the [official site]..., install, and **ensure the application is running**"); change the bolded phrase to plain text so only UI labels or warnings remain bold.
108-108: Split into one sentence per line.This line contains three sentences. For better diff readability, each sentence should be on its own line in the source.
Suggested revision
-If the installer fails with `EACCES` errors, do not use `sudo`. Instead, configure npm to use a directory you own. Refer to the [Troubleshooting guide](../reference/troubleshooting.md#npm-install-fails-with-permission-errors) for the fix. +If the installer fails with `EACCES` errors, do not use `sudo`. +Instead, configure npm to use a directory you own. +Refer to the [Troubleshooting guide](../reference/troubleshooting.md#npm-install-fails-with-permission-errors) for the fix.As per coding guidelines, "One sentence per line in source (makes diffs readable). Flag paragraphs where multiple sentences appear on the same line."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/get-started/install-macos.md` at line 108, The line containing "If the installer fails with `EACCES` errors, do not use `sudo`. Instead, configure npm to use a directory you own. Refer to the [Troubleshooting guide](../reference/troubleshooting.md#npm-install-fails-with-permission-errors) for the fix." should be split so each sentence appears on its own source line; update the documentation entry (the sentence starting "If the installer fails with `EACCES` errors...") to three separate lines: one with the EACCES/sudo instruction, one with the npm directory configuration suggestion, and one with the Troubleshooting guide reference, preserving exact wording and links.
58-58: Use active voice.The phrase "A software update popup will appear" uses passive construction.
Suggested revision
-A software update popup will appear. Click **Install** and wait for the process to complete. +The system displays a software update popup. Click **Install** and wait for the process to complete.Or alternatively:
-A software update popup will appear. Click **Install** and wait for the process to complete. +You will see a software update popup. Click **Install** and wait for the process to complete.As per coding guidelines, "Active voice required. Flag passive constructions."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/get-started/install-macos.md` at line 58, The sentence uses passive voice; rewrite it in active voice by specifying the actor (e.g., the system or macOS) and using an active verb—replace "A software update popup will appear. Click **Install** and wait for the process to complete." with an active construction such as "macOS will display a software update popup; click **Install** and wait for the process to complete." to satisfy the Active voice required guideline.
104-104: Split into one sentence per line.This line contains three sentences. For better diff readability, each sentence should be on its own line in the source.
Suggested revision
-- **Colima:** If the socket is not found, verify Colima is active: `colima status`. Colima may use a non-standard socket path; see the [Troubleshooting guide](../reference/troubleshooting.md#colima-socket-not-detected-macos) for details. +- **Colima:** If the socket is not found, verify Colima is active: `colima status`. + Colima may use a non-standard socket path; see the [Troubleshooting guide](../reference/troubleshooting.md#colima-socket-not-detected-macos) for details.As per coding guidelines, "One sentence per line in source (makes diffs readable). Flag paragraphs where multiple sentences appear on the same line."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/get-started/install-macos.md` at line 104, The paragraph currently contains three sentences on one line; edit the sentence "- **Colima:** If the socket is not found, verify Colima is active: `colima status`. Colima may use a non-standard socket path; see the [Troubleshooting guide](../reference/troubleshooting.md#colima-socket-not-detected-macos) for details." so each sentence is on its own line (i.e., split into three lines: one for the Colima note header and first sentence, one for the `colima status` verification sentence if separate, and one for the note about non-standard socket path with the Troubleshooting guide link) to satisfy the "one sentence per line" guideline.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/get-started/install-macos.md`:
- Line 79: Update the single-sentence version recommendation that currently
reads "If it is below version 20..." to reference "version 22" instead so the
docs align with package.json; locate the sentence in the get-started install
text (the line containing "If it is below version 20, install a newer
version...") and change "20" to "22" and verify the surrounding suggestion to
use nvm/fnm remains unchanged.
- Line 42: Update the Node.js requirement in the docs line that reads "3.
**Node.js:** Version 20 or later" to "Version 22 or later" so it matches the
project's engines requirement (package.json >=22.0.0), and scan the repository
for any other instances of "Version 20" or "Node.js 20/21" to keep documentation
consistent.
---
Nitpick comments:
In `@docs/get-started/install-macos.md`:
- Line 64: Remove the unnecessary bolding around the routine instruction "ensure
the application is running" in the Docker Desktop bullet (the line containing
"**Docker Desktop:** Download from the [official site]..., install, and **ensure
the application is running**"); change the bolded phrase to plain text so only
UI labels or warnings remain bold.
- Line 108: The line containing "If the installer fails with `EACCES` errors, do
not use `sudo`. Instead, configure npm to use a directory you own. Refer to the
[Troubleshooting
guide](../reference/troubleshooting.md#npm-install-fails-with-permission-errors)
for the fix." should be split so each sentence appears on its own source line;
update the documentation entry (the sentence starting "If the installer fails
with `EACCES` errors...") to three separate lines: one with the EACCES/sudo
instruction, one with the npm directory configuration suggestion, and one with
the Troubleshooting guide reference, preserving exact wording and links.
- Line 58: The sentence uses passive voice; rewrite it in active voice by
specifying the actor (e.g., the system or macOS) and using an active
verb—replace "A software update popup will appear. Click **Install** and wait
for the process to complete." with an active construction such as "macOS will
display a software update popup; click **Install** and wait for the process to
complete." to satisfy the Active voice required guideline.
- Line 104: The paragraph currently contains three sentences on one line; edit
the sentence "- **Colima:** If the socket is not found, verify Colima is active:
`colima status`. Colima may use a non-standard socket path; see the
[Troubleshooting
guide](../reference/troubleshooting.md#colima-socket-not-detected-macos) for
details." so each sentence is on its own line (i.e., split into three lines: one
for the Colima note header and first sentence, one for the `colima status`
verification sentence if separate, and one for the note about non-standard
socket path with the Troubleshooting guide link) to satisfy the "one sentence
per line" guideline.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 175ada31-65cc-408a-ba53-0c39aaf78f8f
📒 Files selected for processing (2)
docs/get-started/install-macos.mddocs/reference/troubleshooting.md
✅ Files skipped from review due to trivial changes (1)
- docs/reference/troubleshooting.md
| - [Docker Desktop](https://www.docker.com/products/docker-desktop/) (Recommended for most users) | ||
| - [OrbStack](https://orbstack.dev/) (Fast and lightweight alternative) | ||
| - [Colima](https://github.com/abiosoft/colima) (Open-source CLI-first option) | ||
| 3. **Node.js:** Version 20 or later. |
Contributor
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Description: Verify the Node.js version requirement in package.json
# Expected: Node.js version should be >=22.0.0
cat package.json | jq -r '.engines.node'Repository: NVIDIA/NemoClaw
Length of output: 67
Update Node.js version requirement from "Version 20 or later" to "Version 22 or later".
The documentation at line 42 states "Version 20 or later," but package.json requires >=22.0.0. Users with Node.js 20 or 21 will encounter installation failures.
Recommended fix
-3. **Node.js:** Version 20 or later.
+3. **Node.js:** Version 22 or later.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| 3. **Node.js:** Version 20 or later. | |
| 3. **Node.js:** Version 22 or later. |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/get-started/install-macos.md` at line 42, Update the Node.js requirement
in the docs line that reads "3. **Node.js:** Version 20 or later" to "Version 22
or later" so it matches the project's engines requirement (package.json
>=22.0.0), and scan the repository for any other instances of "Version 20" or
"Node.js 20/21" to keep documentation consistent.
| $ node --version | ||
| ``` | ||
|
|
||
| If it is below version 20, install a newer version from [nodejs.org](https://nodejs.org/) or use a version manager like `nvm` or `fnm`. |
Contributor
There was a problem hiding this comment.
Update the version check to match the corrected requirement.
This line references "version 20" but should reference version 22 to match the actual package.json requirement. This is a downstream effect of the version mismatch flagged at line 42.
📝 Proposed fix
-If it is below version 20, install a newer version from [nodejs.org](https://nodejs.org/) or use a version manager like `nvm` or `fnm`.
+If it is below version 22, install a newer version from [nodejs.org](https://nodejs.org/) or use a version manager like `nvm` or `fnm`.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| If it is below version 20, install a newer version from [nodejs.org](https://nodejs.org/) or use a version manager like `nvm` or `fnm`. | |
| If it is below version 22, install a newer version from [nodejs.org](https://nodejs.org/) or use a version manager like `nvm` or `fnm`. |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/get-started/install-macos.md` at line 79, Update the single-sentence
version recommendation that currently reads "If it is below version 20..." to
reference "version 22" instead so the docs align with package.json; locate the
sentence in the get-started install text (the line containing "If it is below
version 20, install a newer version...") and change "20" to "22" and verify the
surrounding suggestion to use nvm/fnm remains unchanged.
Contributor
|
Can you please fix the failed CI tests? Also please run the /update-docs skill to comply with the NVIDIA style guide. Prompt like the following: The skill is at .agents/skills/update-docs/SKILL.md. |
Contributor
Author
|
/update-docs polish my changes to comply with the NVIDIA style guide |
2 tasks
ahunnargikar-nvidia
added
Platform: macOS
Contributor
|
Thanks for the thorough write-up. A few issues that would need fixing before this could merge:
PR #925 covers the core ask from #814 (macOS first-run checklist in the README) with a smaller, accurate change. Recommending that one moves forward instead. |
Contributor
|
#925 is merged, closing this one out |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Summary
This PR addresses #814 by adding a dedicated macOS Installation Guide and updating the prerequisites section in the README. It provides clear guidance for users on Apple Silicon or Intel machines missing Xcode Command Line Tools and supported container runtimes.
Related Issue
Fixes #814
Changes
xcode-selectguidance and container-runtime socket troubleshooting.Type of Change
Testing
make docsbuilds without warnings.Checklist
General
Doc Changes