Skip to content

cp: fix: nsys multi-report view image from docs.nvidia.com (1466) into r0.4.0#1468

Merged
terrykong merged 1 commit intor0.4.0from
cherry-pick-1466-r0.4.0
Nov 4, 2025
Merged

cp: fix: nsys multi-report view image from docs.nvidia.com (1466) into r0.4.0#1468
terrykong merged 1 commit intor0.4.0from
cherry-pick-1466-r0.4.0

Conversation

@chtruong814
Copy link
Contributor

@chtruong814 chtruong814 commented Nov 3, 2025

beep boop [🤖]: Hi @youngeunkwon0405 👋,

we've cherry picked #1466 into  for you! 🚀

Please review and approve this cherry pick by your convenience!

Summary by CodeRabbit

  • Documentation
    • Updated image formatting in profiling documentation to use standard Markdown syntax for consistency.

Signed-off-by: Youngeun Kwon <youngeunk@nvidia.com>
Signed-off-by: NeMo Bot <nemo-bot@nvidia.com>
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 3, 2025

📝 Walkthrough

Walkthrough

Replaced HTML image tags with Markdown image syntax in the Nsight Systems profiling documentation. Two image references within docs/nsys-profiling.md were converted from HTML <img> elements to standard Markdown image syntax without altering content or behavior.

Changes

Cohort / File(s) Summary
Documentation image syntax update
docs/nsys-profiling.md
Converted two HTML image tags to Markdown syntax for the Nsys multi-report view image

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • NVIDIA-NeMo/RL#1466: Applies the same HTML-to-Markdown image syntax conversion for the Nsight multi-report view in documentation.

Suggested labels

documentation, CI:docs, r0.4.0

Suggested reviewers

  • youngeunkwon0405
  • terrykong

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: fixing an image reference in the nsys-profiling documentation by replacing an HTML tag with Markdown syntax.
Test Results For Major Changes ✅ Passed This PR contains only minor documentation changes converting HTML image tags to Markdown syntax in docs/nsys-profiling.md with no code, functional, or performance impacts.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch cherry-pick-1466-r0.4.0

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 43f5f6a and 1b1cad6.

📒 Files selected for processing (1)
  • docs/nsys-profiling.md (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
docs/**/*.md

📄 CodeRabbit inference engine (CODING_GUIDELINES.md)

When a markdown doc under docs/**/*.md is added or renamed, update docs/index.md to include it in the appropriate section

Files:

  • docs/nsys-profiling.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (10)
  • GitHub Check: Docs_Tests
  • GitHub Check: Docs_Tests
  • GitHub Check: Docs_Tests
  • GitHub Check: sphinx-build / Build docs
  • GitHub Check: Lint check
  • GitHub Check: sphinx-build / Build docs
  • GitHub Check: Lint check
  • GitHub Check: Lint check
  • GitHub Check: Post automodel integration comment / Comment on PR
  • GitHub Check: Post submodule check comment / Comment on PR
🔇 Additional comments (1)
docs/nsys-profiling.md (1)

103-104: Asset confirmed; AI summary inaccuracy identified.

The image asset docs/assets/nsys-multi-report-view.png exists and the Markdown syntax at line 104 is correct. However, the AI summary's claim of "two image references" is inaccurate—there is only one image reference in the file (line 104). The file was modified, not added or renamed, so no docs/index.md update is required. The code change itself is valid.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@terrykong terrykong added the CI:docs Run doctest label Nov 4, 2025
@terrykong terrykong enabled auto-merge (squash) November 4, 2025 06:19
@terrykong terrykong merged commit 73a0871 into r0.4.0 Nov 4, 2025
66 of 70 checks passed
@terrykong terrykong deleted the cherry-pick-1466-r0.4.0 branch November 4, 2025 06:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cherry-pick CI:docs Run doctest documentation Improvements or additions to documentation Run CICD

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants