Skip to content

chore: Add install guide - #42

Merged
AnuradhaKaruppiah merged 3 commits into
NVIDIA:mainfrom
dagardner-nv:david-install-guide-mb
Jul 9, 2026
Merged

chore: Add install guide#42
AnuradhaKaruppiah merged 3 commits into
NVIDIA:mainfrom
dagardner-nv:david-install-guide-mb

Conversation

@dagardner-nv

@dagardner-nv dagardner-nv commented Jul 9, 2026

Copy link
Copy Markdown
Collaborator

Overview

  • Document installing Fabric from source and packages
  • Once Fabric is deployed on pypi the Package installation method will be listed first
  • Minor cleanup to docs/getting-started/overview.mdx

Where should the reviewer start?

docs/getting-started/install.mdx

Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)

  • Closes FABRIC-55

  • I confirm this contribution is my own work, or I have the right to submit it under this project's license.

  • I searched existing issues and open pull requests, and this does not duplicate existing work.

Summary by CodeRabbit

  • Documentation
    • Added a new “Install” guide for NeMo Fabric, including prerequisites and multiple setup options (source build and package/wheel-based installation), plus example commands for installing runtime adapters.
    • Updated the quick start to make adding Cargo’s binary directory to PATH an explicit standalone step.
    • Extended the Getting Started navigation to include the new Install page and linked it from the docs index.

Signed-off-by: David Gardner <dagardner@nvidia.com>
Signed-off-by: David Gardner <dagardner@nvidia.com>
@linear

linear Bot commented Jul 9, 2026

Copy link
Copy Markdown

@dagardner-nv
dagardner-nv marked this pull request as ready for review July 9, 2026 00:17
@coderabbitai

coderabbitai Bot commented Jul 9, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Enterprise

Run ID: 11948eb4-4aac-4081-b694-e6031014dcc6

📥 Commits

Reviewing files that changed from the base of the PR and between 1f0e00b and 9501714.

📒 Files selected for processing (2)
  • docs/getting-started/overview.mdx
  • docs/index.yml
📜 Recent review details
⏰ Context from checks skipped due to timeout. (3)
  • GitHub Check: Build and publish docs
  • GitHub Check: Build wheels
  • GitHub Check: Test
🧰 Additional context used
📓 Path-based instructions (1)
{docs/**,README.md,AGENTS.md}

⚙️ CodeRabbit configuration file

{docs/**,README.md,AGENTS.md}: Review documentation for technical accuracy against the current API, command correctness, and consistency with generated schemas.

Files:

  • docs/index.yml
  • docs/getting-started/overview.mdx
🔇 Additional comments (2)
docs/getting-started/overview.mdx (1)

76-92: LGTM!

docs/index.yml (1)

9-10: LGTM!


Walkthrough

This PR adds a new installation guide with prerequisites plus source and package install steps, updates the quick-start flow to separate Cargo PATH setup, and adds the new page to the docs navigation.

Changes

Installation Documentation

Layer / File(s) Summary
New install guide content
docs/getting-started/install.mdx
Adds prerequisites, source installation steps with uv venv and just build-all, and package installation steps with just wheels and uv pip install --find-links plus adapter examples.
Quick-start PATH update and navigation link
docs/getting-started/overview.mdx, docs/index.yml
Moves the Cargo bin PATH export into its own quick-start step and adds a Getting Started nav entry for the new Install page.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

  • NVIDIA/NeMo-Relay#385: Also edits docs/index.yml navigation entries, so it touches the same docs nav structure.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title follows Conventional Commits format and accurately summarizes the install guide addition.
Description check ✅ Passed The description includes the required Overview, reviewer-start, related issue, and confirmation sections.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

@github-actions

github-actions Bot commented Jul 9, 2026

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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 `@docs/getting-started/install.mdx`:
- Around line 45-80: The install examples in the Fabric runtime and adapter
sections should explicitly target the active virtual environment rather than
relying on whatever interpreter uv picks up. Update the `uv pip install`
examples near the `just wheels` and `nemo-fabric[runtime]` /
`nemo-fabric[adapters-hermes-sdk]` commands to either include a venv activation
note or pass an explicit `--python` value so installs go into the intended
environment.
🪄 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: ASSERTIVE

Plan: Enterprise

Run ID: ad9c1bd0-9850-4773-80ba-3b0a251a6f5e

📥 Commits

Reviewing files that changed from the base of the PR and between 4252cfe and 1f0e00b.

📒 Files selected for processing (3)
  • docs/getting-started/install.mdx
  • docs/getting-started/overview.mdx
  • docs/index.yml
📜 Review details
🧰 Additional context used
📓 Path-based instructions (1)
{docs/**,README.md,AGENTS.md}

⚙️ CodeRabbit configuration file

{docs/**,README.md,AGENTS.md}: Review documentation for technical accuracy against the current API, command correctness, and consistency with generated schemas.

Files:

  • docs/getting-started/overview.mdx
  • docs/index.yml
  • docs/getting-started/install.mdx
🔇 Additional comments (2)
docs/getting-started/overview.mdx (1)

76-87: LGTM!

docs/index.yml (1)

9-10: LGTM!

Comment thread docs/getting-started/install.mdx
@AnuradhaKaruppiah

Copy link
Copy Markdown
Collaborator

/merge

@AnuradhaKaruppiah
AnuradhaKaruppiah merged commit 2d2b19a into NVIDIA:main Jul 9, 2026
6 checks passed
@dagardner-nv
dagardner-nv deleted the david-install-guide-mb branch July 9, 2026 15:34
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.

3 participants