Skip to content

docs: update README Learn More links to point to in-repo docs#974

Open
areporeporepo wants to merge 1 commit intoNVIDIA:mainfrom
areporeporepo:docs/update-readme-learn-more-links
Open

docs: update README Learn More links to point to in-repo docs#974
areporeporepo wants to merge 1 commit intoNVIDIA:mainfrom
areporeporepo:docs/update-readme-learn-more-links

Conversation

@areporeporepo
Copy link
Copy Markdown
Contributor

@areporeporepo areporeporepo commented Mar 26, 2026

Summary

Replace external docs.nvidia.com/nemoclaw links in README.md with relative paths to the in-repo docs/ directory. The external links were valid but outdated since PRs #911 and #603 added the corresponding documentation pages to the repository.

Changes:

  • Customize Network Policy link → docs/network-policy/customize-network-policy.md
  • CLI reference link → docs/reference/commands.md
  • All Learn More section links → their docs/ counterparts

OpenShell external links (Policy Schema, Sandbox Policies) are intentionally preserved since they reference a different repository.

All linked docs/ files verified to exist.

Closes #968

Signed-off-by: areporeporepo

Summary by CodeRabbit

  • Documentation
    • Updated documentation links to reference local Markdown files instead of external resources for improved accessibility and faster access to NemoClaw documentation.

Replace external docs.nvidia.com/nemoclaw links with relative paths
to the in-repo /docs/ directory. The external links were valid but
outdated since PRs NVIDIA#911 and NVIDIA#603 added the corresponding pages to
the repository.

Closes NVIDIA#968

Co-authored-by: Copilot <[email protected]>
Signed-off-by: Anh Quang Nguyen <[email protected]>
Copilot AI review requested due to automatic review settings March 26, 2026 15:07
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 26, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 067d2467-3a96-4d48-8d80-a4350c72fd99

📥 Commits

Reviewing files that changed from the base of the PR and between f0f53e4 and d9b9311.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

README documentation links updated from external NVIDIA documentation URLs to local repository Markdown files for NemoClaw docs. Links now reference in-repo documentation for network policies, CLI reference, and "Learn More" section items. One external link to OpenShell Policy Schema remains unchanged.

Changes

Cohort / File(s) Summary
Documentation Links
README.md
Updated multiple links from external https://docs.nvidia.com/... URLs to local relative Markdown file paths for NemoClaw documentation (network policies, CLI reference, troubleshooting, and "Learn More" section). OpenShell Policy Schema link remains external.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 Links once distant, now are near,
The docs hop closer, crystal clear,
From distant NVIDIA clouds they came,
To local markdown, home to claim,
A tidy README, updated right! 📚✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely summarizes the main change: updating README documentation links to point to in-repo docs instead of external sources.
Linked Issues check ✅ Passed The pull request fully addresses issue #968 by replacing external docs.nvidia.com links with relative paths to in-repo docs files in the README Learn More section.
Out of Scope Changes check ✅ Passed All changes are directly scoped to the stated objective: updating README documentation links to point to in-repo docs. No unrelated modifications are present.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the root README to point “Learn More” and related documentation links to the repository’s in-tree docs/ markdown pages instead of the external docs.nvidia.com/nemoclaw site, aligning the README with the newer in-repo documentation added in prior PRs.

Changes:

  • Replaces the external “Customize Network Policy” link with docs/network-policy/customize-network-policy.md.
  • Replaces the external “CLI reference” link with docs/reference/commands.md.
  • Updates all “Learn More” section links to their corresponding docs/ pages while preserving OpenShell links that intentionally remain external.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

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.

README “Learn More” links point to external NVIDIA docs instead of in‑repo docs

2 participants