docs: fix the ref link to spark instruction, minor style fixes, add README to docs workflow - #392
Conversation
📝 WalkthroughWalkthroughAdded Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
📝 Coding Plan
Comment |
There was a problem hiding this comment.
🧹 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
📒 Files selected for processing (2)
.github/workflows/docs.yamlREADME.md
…EADME to docs workflow (NVIDIA#392) * fix link and add README to docs workflow * workaround for rendering correctly in both raw md and myst
…EADME to docs workflow (NVIDIA#392) * fix link and add README to docs workflow * workaround for rendering correctly in both raw md and myst
Summary by CodeRabbit