chore: Add install guide - #42
Conversation
Signed-off-by: David Gardner <dagardner@nvidia.com>
Signed-off-by: David Gardner <dagardner@nvidia.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Enterprise Run ID: 📒 Files selected for processing (2)
📜 Recent review details⏰ Context from checks skipped due to timeout. (3)
🧰 Additional context used📓 Path-based instructions (1){docs/**,README.md,AGENTS.md}⚙️ CodeRabbit configuration file
Files:
🔇 Additional comments (2)
WalkthroughThis 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. ChangesInstallation Documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
📖 Fern docs preview: https://nvidia-preview-pull-request-42.docs.buildwithfern.com/nemo/fabric |
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 `@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
📒 Files selected for processing (3)
docs/getting-started/install.mdxdocs/getting-started/overview.mdxdocs/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.mdxdocs/index.ymldocs/getting-started/install.mdx
🔇 Additional comments (2)
docs/getting-started/overview.mdx (1)
76-87: LGTM!docs/index.yml (1)
9-10: LGTM!
|
/merge |
Overview
docs/getting-started/overview.mdxWhere should the reviewer start?
docs/getting-started/install.mdxRelated 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
PATHan explicit standalone step.