Skip to content

docs: point README learn more links to repo docs#1008

Open
WuKongAI-CMU wants to merge 1 commit intoNVIDIA:mainfrom
WuKongAI-CMU:docs/968-readme-links-v2
Open

docs: point README learn more links to repo docs#1008
WuKongAI-CMU wants to merge 1 commit intoNVIDIA:mainfrom
WuKongAI-CMU:docs/968-readme-links-v2

Conversation

@WuKongAI-CMU
Copy link
Copy Markdown
Contributor

@WuKongAI-CMU WuKongAI-CMU commented Mar 27, 2026

Summary

  • replace the README Learn More links that point to external NVIDIA docs
  • point each Learn More entry to the corresponding in-repo page under docs/

Testing

  • not run (docs-only change)

Closes #968

Summary by CodeRabbit

  • Documentation
    • Updated documentation links in README to reference internal repository resources instead of external URLs.

@WuKongAI-CMU
Copy link
Copy Markdown
Contributor Author

Addresses #968 by replacing the README Learn More external documentation links with the matching in-repo pages under docs/.

@coderabbitai review

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 27, 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: 9f364aef-47a7-4d60-bfaa-2f9b55c4aa84

📥 Commits

Reviewing files that changed from the base of the PR and between 5c269c1 and b9a3ea7.

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

📝 Walkthrough

Walkthrough

The README.md "Learn More" section documentation links are updated to reference internal repository files under docs/ instead of external NVIDIA documentation URLs. This redirects users to locally maintained documentation pages rather than external hosted versions.

Changes

Cohort / File(s) Summary
Documentation Links
README.md
Updated "Learn More" section links from external NVIDIA Docs URLs to internal repository documentation files (docs/about/overview.md, docs/reference/commands.md, docs/reference/troubleshooting.md).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 Hops through the README with glee,
Links now point where docs should be,
No more chasing external URLs so far,
Local paths shine like a guiding star!

🚥 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 'docs: point README learn more links to repo docs' accurately and concisely describes the main change: redirecting README documentation links from external to internal repository documentation.
Linked Issues check ✅ Passed The PR fulfills the objective from issue #968: it updates README 'Learn More' links from external NVIDIA docs URLs to internal repository documentation pages under /docs/.
Out of Scope Changes check ✅ Passed All changes are in-scope and directly related to the stated objective—only README.md documentation links were modified with no unrelated alterations.
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.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 27, 2026

@WuKongAI-CMU Sure! I'll review the changes now.

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@WuKongAI-CMU
Copy link
Copy Markdown
Contributor Author

Clarifying active branch state: #1008 is the active PR for issue #968. The other README-link PRs were duplicate attempts and are closed.

@coderabbitai review

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 27, 2026

@WuKongAI-CMU Thanks for the clarification! Noted that #1008 is the canonical active PR for issue #968 — the other README-link PRs were duplicates and have been closed. I'll kick off a fresh review now.

(^・ω・^ )ノ


✏️ Learnings added
Learnt from: WuKongAI-CMU
URL: https://github.com/NVIDIA/NemoClaw/pull/1008

Timestamp: 2026-03-27T02:27:58.738Z
Learning: PR `#1008` in the NVIDIA/NemoClaw repository is the active, canonical PR for issue `#968` (replacing README "Learn More" external documentation links with matching in-repo pages under `docs/`). All other README-link PRs addressing the same issue were duplicate attempts and have been closed.

Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

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

1 participant