Skip to content

Update README documentation links#3773

Open
jpc204 wants to merge 1 commit into
NVIDIA:mainfrom
jpc204:agent/update-readme-doc-links
Open

Update README documentation links#3773
jpc204 wants to merge 1 commit into
NVIDIA:mainfrom
jpc204:agent/update-readme-doc-links

Conversation

@jpc204

@jpc204 jpc204 commented Jul 21, 2026

Copy link
Copy Markdown

Summary

  • point the README Overview link to the repository's docs/overview/what-is-nico.md
  • point the README Quick Start link to docs/getting-started/quick-start.md
  • retain a separate link to the published NICo web documentation

Why

The Getting Started links should take GitHub readers directly to the documentation maintained in this repository while still making the published web documentation discoverable.

Impact

README visitors can review the Overview and Quick Start content in the same repository and choose the web documentation when preferred.

Validation

  • confirmed both repository-relative documentation targets exist
  • ran git diff --check

Signed-off-by: Jared Conway <jaredc@nvidia.com>
@copy-pr-bot

copy-pr-bot Bot commented Jul 21, 2026

Copy link
Copy Markdown

Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually.

Contributors can view more details about this message here.

@coderabbitai

coderabbitai Bot commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: fb9bbb3c-decf-4c7e-9c23-67d077625fa8

📥 Commits

Reviewing files that changed from the base of the PR and between 1a24cd5 and eb0292d.

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

Summary by CodeRabbit

  • Documentation
    • Updated the README’s “Getting Started” links to point to the repository’s local overview and quick-start guides.
    • Retained a link to the NICo web documentation for additional information.

Walkthrough

Updated the README Getting Started navigation to link to local overview and quick-start documentation, alongside NICo web documentation.

Changes

README navigation

Layer / File(s) Summary
Update Getting Started links
README.md
Replaced the previous NVIDIA-hosted overview and quick-start links with repository-local documentation paths and adjusted the bullet list.

Estimated code review effort: 1 (Trivial) | ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: updating README documentation links.
Description check ✅ Passed The description is directly related to the README link updates and validation performed.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

@jpc204
jpc204 marked this pull request as ready for review July 21, 2026 21:18
@jpc204
jpc204 requested a review from a team as a code owner July 21, 2026 21:18
@ajf
ajf enabled auto-merge (squash) July 21, 2026 21:25
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.

2 participants