docs: update README Learn More links to point to in-repo docs#974
docs: update README Learn More links to point to in-repo docs#974areporeporepo wants to merge 1 commit intoNVIDIA:mainfrom
Conversation
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]>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughREADME 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
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 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 |
There was a problem hiding this comment.
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.
Summary
Replace external
docs.nvidia.com/nemoclawlinks in README.md with relative paths to the in-repodocs/directory. The external links were valid but outdated since PRs #911 and #603 added the corresponding documentation pages to the repository.Changes:
docs/network-policy/customize-network-policy.mddocs/reference/commands.mddocs/counterpartsOpenShell 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