Skip to content

docs: fix the ref link to spark instruction, minor style fixes, add README to docs workflow - #392

Merged
ericksoa merged 2 commits into
mainfrom
docs/fix-link
Mar 19, 2026
Merged

docs: fix the ref link to spark instruction, minor style fixes, add README to docs workflow#392
ericksoa merged 2 commits into
mainfrom
docs/fix-link

Conversation

@miyoungc

@miyoungc miyoungc commented Mar 19, 2026

Copy link
Copy Markdown
Collaborator

Summary by CodeRabbit

  • Documentation
    • Updated DGX Spark link to point to the correct repository and adjusted callout styling (NOTE → ℹ️ Note, TIP → 💡 Tip).
  • Chores
    • Documentation workflow now triggers on README changes so updates to the README will run the docs workflow.

@coderabbitai

coderabbitai Bot commented Mar 19, 2026

Copy link
Copy Markdown
Contributor
📝 Walkthrough

Walkthrough

Added README.md to the docs workflow PR path filter; README callout formatting was reworded (note/tip styles) and the DGX Spark guide link changed from a relative path to an absolute GitHub URL.

Changes

Cohort / File(s) Summary
Workflow Configuration
.github/workflows/docs.yaml
Added README.md to the paths filter for pull_request triggers; no other workflow logic changed.
Documentation
README.md
Replaced > [!NOTE]/> [!TIP] callouts with > **ℹ️ Note** / > **💡 Tip** formatting (added blank line after label); updated DGX Spark link from spark-install.md to absolute GitHub URL (https://github.com/NVIDIA/NemoClaw/.../spark-install.md).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 I hopped through lines with eager cheer,

ℹ️ Note and 💡 Tip now crisp and clear,
Links wind outward to GitHub's light,
The docs watch README—day and night,
A tiny rabbit nods: "All right!" 🥕

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check ✅ Passed The title accurately summarizes the main changes: fixing the spark instruction reference link, applying style fixes to README, and adding README to the docs workflow trigger.

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

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/fix-link
📝 Coding Plan
  • Generate coding plan for human review comments

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
README.md (1)

64-64: Clarify intent: absolute URL with hardcoded /blob/main/ causes version coupling.

The file exists, but using an absolute GitHub URL with /blob/main/ means this link will always point to the latest version on the main branch, regardless of which README version (tag, branch, or release) a user is viewing. Users reading older releases will see instructions for the current main version, which could contain breaking changes or incompatible prerequisites.

Either confirm this is intentional (to always show the latest Spark setup), or consider using a relative link (spark-install.md) to keep documentation consistent with the README version being viewed.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 64, The README currently links the DGX Spark setup with an
absolute GitHub URL containing /blob/main/, which ties readers to the main
branch; either confirm that behavior is intentional or change the link target in
README.md from the absolute URL to a relative link ("spark-install.md") so
readers viewing tagged/branch releases see the matching doc; update the link
text "DGX Spark setup guide" accordingly and ensure any CI/doc tooling still
resolves the relative path.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@README.md`:
- Line 64: The README currently links the DGX Spark setup with an absolute
GitHub URL containing /blob/main/, which ties readers to the main branch; either
confirm that behavior is intentional or change the link target in README.md from
the absolute URL to a relative link ("spark-install.md") so readers viewing
tagged/branch releases see the matching doc; update the link text "DGX Spark
setup guide" accordingly and ensure any CI/doc tooling still resolves the
relative path.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 6874184d-c301-4a0c-8fdf-cafe1e11cde8

📥 Commits

Reviewing files that changed from the base of the PR and between 3ba517d and c106ded.

📒 Files selected for processing (2)
  • .github/workflows/docs.yaml
  • README.md

@miyoungc miyoungc self-assigned this Mar 19, 2026
@miyoungc miyoungc changed the title docs: fix link and add README to docs workflow docs: fix the ref link to spark instruction, minor style fixes, add README to docs workflow Mar 19, 2026

@ericksoa ericksoa left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

lgtm

@ericksoa
ericksoa merged commit 20a63d0 into main Mar 19, 2026
4 checks passed
Ryuketsukami pushed a commit to Ryuketsukami/NemoClaw that referenced this pull request Mar 24, 2026
…EADME to docs workflow (NVIDIA#392)

* fix link and add README to docs workflow

* workaround for rendering correctly in both raw md and myst
jessesanford pushed a commit to jessesanford/NemoClaw that referenced this pull request Mar 24, 2026
…EADME to docs workflow (NVIDIA#392)

* fix link and add README to docs workflow

* workaround for rendering correctly in both raw md and myst
@miyoungc
miyoungc deleted the docs/fix-link branch May 27, 2026 20:52
@wscurran wscurran added area: docs Documentation, examples, guides, or docs build chore Build, CI, dependency, or tooling maintenance and removed documentation labels Jun 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: docs Documentation, examples, guides, or docs build chore Build, CI, dependency, or tooling maintenance

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants