Skip to content

docs: Guided user reading path and document nemo-relay install#97

Merged
rapids-bot[bot] merged 25 commits into
NVIDIA:mainfrom
dagardner-nv:david-more-docs
Jul 22, 2026
Merged

docs: Guided user reading path and document nemo-relay install#97
rapids-bot[bot] merged 25 commits into
NVIDIA:mainfrom
dagardner-nv:david-more-docs

Conversation

@dagardner-nv

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

Copy link
Copy Markdown
Collaborator

Overview

  • Guide the user from README.md --> Notebooks --> Python SDK Guide --> Examples
  • Document installing the nemo-relay CLI tool
  • Remove YAML specific documentetion from "Core Concepts" section of README.md
  • Always refer to Hermes Agent as "Hermes Agent" not "Hermes"
  • Remove "SDK" from the name of the Codex adapter
  • Remove developer specific information from adapters/codex/README.md

Replaces PR #91

Where should the reviewer start?

  • README.md
  • docs/getting-started/install.mdx

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

  • Closes FABRIC-99 FABRIC-83

  • 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
    • Updated product terminology throughout guides, examples, notebooks, schemas, and adapter documentation to consistently use “NVIDIA NeMo Fabric” and “NeMo Fabric.”
    • Clarified Hermes Agent, Codex, Claude, Deep Agents, Harbor, and NeMo Relay setup and integration guidance.
    • Added detailed NeMo Relay installation instructions for Python, CLI, Windows, and Cargo environments.
    • Improved configuration, runtime, telemetry, troubleshooting, and workflow explanations.

Signed-off-by: David Gardner <dagardner@nvidia.com>
Signed-off-by: David Gardner <dagardner@nvidia.com>
…, some some developer focused docs from the codex readme

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

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

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

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

coderabbitai Bot commented Jul 22, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Enterprise

Run ID: e8ca80b6-477f-45fd-9fe3-4be4e0468c3e

📥 Commits

Reviewing files that changed from the base of the PR and between 4f3f592 and 84aa3da.

📒 Files selected for processing (43)
  • .agents/skills/README.md
  • .agents/skills/python-tests/SKILL.md
  • .agents/skills/small-fix/SKILL.md
  • .agents/skills/update-project-version/SKILL.md
  • .coderabbit.yaml
  • .github/workflows/ci_python.yml
  • CONTRIBUTING.md
  • README.md
  • TODO.md
  • adapters/README.md
  • adapters/claude/README.md
  • adapters/codex/README.md
  • adapters/codex/pyproject.toml
  • adapters/codex/src/nemo_fabric_adapters/codex/__init__.py
  • adapters/common/README.md
  • adapters/common/src/nemo_fabric_adapters/common/utils.py
  • adapters/deepagents/README.md
  • adapters/hermes/README.md
  • docs/about-nemo-fabric/overview.mdx
  • docs/experimentation/cli.mdx
  • docs/getting-started/install.mdx
  • docs/integrations/codex.mdx
  • docs/integrations/harbor.mdx
  • docs/sdk/python.mdx
  • examples/README.md
  • examples/code_review_agent/README.md
  • examples/harbor/README.md
  • examples/harbor/calculator/README.md
  • examples/harbor/swebench/README.md
  • examples/harbor/swebench/sample-artifacts/README.md
  • examples/notebooks/01_quickstart.ipynb
  • examples/notebooks/02_variations.ipynb
  • examples/notebooks/README.md
  • pypi.md
  • python/src/nemo_fabric/integrations/harbor/README.md
  • schemas/SCHEMA.md
  • scripts/generate_api_docs.sh
  • skills/README.md
  • skills/nemo-fabric-integrate/SKILL.md
  • skills/nemo-fabric-integrate/references/config-mapping.md
  • skills/nemo-fabric-integrate/references/results-and-errors.md
  • skills/nemo-fabric-integrate/references/sdk-api-inventory.md
  • tests/fixtures/hermes-shim-agent/repos/my-service/README.md

Walkthrough

The PR standardizes product and harness naming across maintainer guidance, adapter documentation, public docs, examples, notebooks, schemas, and fixtures. It also adds NeMo Relay installation guidance and clarifies selected adapter, credential, and telemetry instructions.

Changes

Documentation and terminology alignment

Layer / File(s) Summary
Maintainer guidance and review rules
.agents/skills/*, .coderabbit.yaml, .github/workflows/*, CONTRIBUTING.md, TODO.md, skills/*
Skill metadata, review instructions, contributor examples, CI comments, and integration guidance now use NeMo Fabric and Hermes Agent terminology.
Root and adapter documentation
README.md, adapters/*, adapters/common/*
Root and adapter documentation updates cover product naming, runtime behavior, tools blocking, Hermes Agent terminology, and Relay integration instructions.
Public docs and installation flows
docs/*, pypi.md
Installation, Python-version constraints, NeMo Relay options, harness naming, SDK concepts, and integration references were updated.
Examples and notebooks
examples/*
Examples and notebooks now use current product and harness names, add credential checks in Harbor walkthroughs, and update Relay evidence instructions.
Schemas and supporting references
schemas/*, scripts/*, python/src/*, tests/fixtures/*
Schema descriptions, generated API frontmatter, package documentation, and fixture wording were aligned with NeMo Fabric terminology.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Possibly related PRs

  • NVIDIA/NeMo-Fabric#91: Updates overlapping NeMo Relay installation guidance and Hermes Agent/Python-version documentation.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 Checkov (3.3.8)
.coderabbit.yaml

Traceback (most recent call last):
File "/usr/local/bin/checkov", line 2, in
from checkov.main import Checkov
ModuleNotFoundError: No module named 'checkov'

.github/workflows/ci_python.yml

Traceback (most recent call last):
File "/usr/local/bin/checkov", line 2, in
from checkov.main import Checkov
ModuleNotFoundError: No module named 'checkov'


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

@github-actions

Copy link
Copy Markdown

@dagardner-nv

Copy link
Copy Markdown
Collaborator Author

/merge

@rapids-bot
rapids-bot Bot merged commit 9179cd3 into NVIDIA:main Jul 22, 2026
20 of 21 checks passed
@dagardner-nv
dagardner-nv deleted the david-more-docs branch July 22, 2026 16:46
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