Skip to content

docs(user): drop emoji markers in troubleshooting code comments#243

Open
mesutoezdil wants to merge 1 commit into
NVIDIA:mainfrom
mesutoezdil:mesutoezdil/docs/fix-troubleshooting-emoji
Open

docs(user): drop emoji markers in troubleshooting code comments#243
mesutoezdil wants to merge 1 commit into
NVIDIA:mainfrom
mesutoezdil:mesutoezdil/docs/fix-troubleshooting-emoji

Conversation

@mesutoezdil

@mesutoezdil mesutoezdil commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

docs/user/troubleshooting.md used emoji to mark wrong/correct examples. This repo's doc style forbids emoji. Replaced with plain WRONG / CORRECT text.

Tested: ran ./tools/ci/check-docs (0 errors).

Refs: NO-REF

Repo documentation style forbids emojis. Replace the WRONG/CORRECT
code-block markers with plain text.

JIRA: NO-REF
NVBug: none
Signed-off-by: mesutoezdil <mesudozdil@gmail.com>
@mesutoezdil
mesutoezdil requested a review from a team as a code owner July 17, 2026 16:41
@coderabbitai

coderabbitai Bot commented Jul 17, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The troubleshooting documentation clarifies the incorrect Docker credential encoding example by labeling API-key-only encoding, showing its output separately, and repositioning the correct encoding guidance.

Changes

Credential troubleshooting documentation

Layer / File(s) Summary
Encoding example clarification
docs/user/troubleshooting.md
The incorrect Base64 example is labeled and separated from the correct credential encoding instructions.

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

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
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.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the doc-only change to replace emoji markers in troubleshooting code comments.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

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.

1 participant