docs: restore setup playbook - #132
Merged
Merged
Conversation
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughThis PR adds a repository-root SETUP.md as the canonical NeMo platform setup guide and updates README, AGENTS.md, skill, and plugin docs to reference it instead of the old skill-based setup doc. ChangesSetup Documentation Consolidation
Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 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: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
SETUP.md (2)
1-225: 🛠️ Refactor suggestion | 🟠 Major | 🏗️ Heavy liftDocument mixes HOW-TO and REFERENCE content.
The guide combines setup procedures (HOW-TO) with skills inventory tables (REFERENCE). Each documentation page should fit ONE Diataxis quadrant. Split the skills reference content (lines 176-224) into a separate reference page and cross-link.
As per coding guidelines: Each documentation page should fit ONE Diataxis quadrant; do not mix tutorials with reference tables or how-tos with architecture explanations; use cross-links instead.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@SETUP.md` around lines 1 - 225, SETUP.md currently mixes HOW‑TO content with a reference skills inventory under the "Available skills" / "What's next?" section; split the reference table into a new reference document (e.g., "SKILLS_REFERENCE.md") and replace the table in SETUP.md with a short cross‑link and one‑line summary pointing to that new doc; update the symlinked skill copy (the existing SKILL.md symlink target) or its metadata to point to the new reference file as appropriate, and ensure headings like "Available skills" and the "What's next?" table are removed from SETUP.md so the page remains a single HOW‑TO Diataxis quadrant while the new reference page holds the inventory and plugin mapping.
1-225: 🛠️ Refactor suggestion | 🟠 Major | ⚡ Quick winHardcoded product names throughout.
Lines 3, 7, 9, 11, and many others hardcode "NeMo Platform", "NeMo", "Switchyard", and other product names. Use Sphinx substitutions to maintain consistency across documentation.
As per coding guidelines: Never hardcode product names; use substitutions in Sphinx configuration to maintain consistency across documentation.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@SETUP.md` around lines 1 - 225, This file hardcodes product names like "NeMo Platform", "NeMo", and "Switchyard" — replace every hardcoded occurrence (e.g., the strings "NeMo Platform", "NeMo", "Switchyard", "nemo-switchyard") in SETUP.md with the appropriate Sphinx substitution tokens used in our docs (e.g., |product_name|, |product_short|, |switchyard| or whatever substitutions are defined in the Sphinx conf), keeping punctuation/capitalization consistent; update any inline examples and environment variable references to use the substitution where appropriate or add a short note that environment variable names remain literal, and run a quick grep to ensure no remaining literal product names remain.
🧹 Nitpick comments (1)
SETUP.md (1)
24-36: ⚡ Quick winWrap troubleshooting options in dropdown.
Lines 24-36 provide detailed troubleshooting for port conflicts—content most users skip. Use
<details>tag to hide complexity.As per coding guidelines: Use dropdowns for optional/advanced content, advanced sections, troubleshooting details, long examples, and content most users will skip; not for critical information, prerequisites, warnings, or primary content.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@SETUP.md` around lines 24 - 36, The long troubleshooting block starting "If port 8080 is in use **or** a `nemo services run` process exists…" should be converted into a summary plus a collapsible details section: keep a short visible summary of the three user choices (a Kill and start fresh; b Keep running and skip setup; c Abort) and the important macOS "unlinked-inode gotcha" warning visible outside the dropdown, then wrap the detailed numbered procedure, the caveats list, and the longer explanatory paragraphs inside a <details>…</details> with an appropriate <summary> like "Advanced troubleshooting and safe restart steps"; ensure the detailed steps still include the specific actions (SIGTERM, wait, re-verify PID command line, SIGKILL, wipe DB, checks for plugins and services) and that the macOS warning remains prominently visible and not hidden.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@SETUP.md`:
- Around line 74-85: Replace the two sequential bash code blocks that show
interactive ("make bootstrap", "source .venv/bin/activate", "nemo setup") and
non-interactive (export NVIDIA_API_KEY, "nemo setup --auto --start-services
--install-skills --deploy-agent") alternatives with a tab-set demonstrating both
options in parallel; create two tabs labeled e.g. "Interactive" and
"Non-interactive (CI)" and place the respective commands in each tab so readers
can toggle between the alternatives instead of seeing consecutive code blocks.
---
Outside diff comments:
In `@SETUP.md`:
- Around line 1-225: SETUP.md currently mixes HOW‑TO content with a reference
skills inventory under the "Available skills" / "What's next?" section; split
the reference table into a new reference document (e.g., "SKILLS_REFERENCE.md")
and replace the table in SETUP.md with a short cross‑link and one‑line summary
pointing to that new doc; update the symlinked skill copy (the existing SKILL.md
symlink target) or its metadata to point to the new reference file as
appropriate, and ensure headings like "Available skills" and the "What's next?"
table are removed from SETUP.md so the page remains a single HOW‑TO Diataxis
quadrant while the new reference page holds the inventory and plugin mapping.
- Around line 1-225: This file hardcodes product names like "NeMo Platform",
"NeMo", and "Switchyard" — replace every hardcoded occurrence (e.g., the strings
"NeMo Platform", "NeMo", "Switchyard", "nemo-switchyard") in SETUP.md with the
appropriate Sphinx substitution tokens used in our docs (e.g., |product_name|,
|product_short|, |switchyard| or whatever substitutions are defined in the
Sphinx conf), keeping punctuation/capitalization consistent; update any inline
examples and environment variable references to use the substitution where
appropriate or add a short note that environment variable names remain literal,
and run a quick grep to ensure no remaining literal product names remain.
---
Nitpick comments:
In `@SETUP.md`:
- Around line 24-36: The long troubleshooting block starting "If port 8080 is in
use **or** a `nemo services run` process exists…" should be converted into a
summary plus a collapsible details section: keep a short visible summary of the
three user choices (a Kill and start fresh; b Keep running and skip setup; c
Abort) and the important macOS "unlinked-inode gotcha" warning visible outside
the dropdown, then wrap the detailed numbered procedure, the caveats list, and
the longer explanatory paragraphs inside a <details>…</details> with an
appropriate <summary> like "Advanced troubleshooting and safe restart steps";
ensure the detailed steps still include the specific actions (SIGTERM, wait,
re-verify PID command line, SIGKILL, wipe DB, checks for plugins and services)
and that the macOS warning remains prominently visible and not hidden.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 26a68ca2-ae18-4934-80bd-ec2c29ab8a86
📒 Files selected for processing (4)
AGENTS.mdREADME.mdSETUP.mdskills/nemo-setup/SKILL.md
Contributor
|
Signed-off-by: Nick Goncharenko <ngoncharenko@nvidia.com>
ngoncharenko
force-pushed
the
ngoncharenko/aalgo-214-get-setup-back
branch
from
June 2, 2026 21:02
7526ea1 to
08e6be9
Compare
Signed-off-by: Nick Goncharenko <ngoncharenko@nvidia.com>
ngoncharenko
enabled auto-merge
June 2, 2026 21:16
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@SETUP.md`:
- Around line 74-87: Replace the indented code blocks under the "Interactive"
and "Non-interactive (CI)" headings with fenced Bash code blocks: wrap the lines
containing the commands (make bootstrap, source .venv/bin/activate, nemo setup,
and export NVIDIA_API_KEY / nemo setup --auto --start-services --install-skills
--deploy-agent) in triple-backtick fences with "bash" specified (```bash ...
```), preserving the exact command content and comments so the MD046 warnings
are resolved.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: af439e1f-67bb-485c-b095-61f3bcd18581
📒 Files selected for processing (1)
SETUP.md
Signed-off-by: Nick Goncharenko <ngoncharenko@nvidia.com>
gabwow
approved these changes
Jun 4, 2026
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
2 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
SETUP.mdsetup playbook from history. It was removed in this PR feat: add repo-root skills for NVSkills catalog #104, but we had to roll back skills/nemo-setup due pipeline passing issuesSummary by CodeRabbit