Skip to content

docs: use bash language tag for shell code fences#11063

Merged
rmccorm4 merged 2 commits into
ai-dynamo:mainfrom
cpakkamisaac-sae:cpakkamisaac/docs-bash-code-fences
Jun 30, 2026
Merged

docs: use bash language tag for shell code fences#11063
rmccorm4 merged 2 commits into
ai-dynamo:mainfrom
cpakkamisaac-sae:cpakkamisaac/docs-bash-code-fences

Conversation

@cpakkamisaac-sae

@cpakkamisaac-sae cpakkamisaac-sae commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

Summary

Three shell code blocks under docs/ were tagged ```sh. The docs style guide (docs/AGENTS.md) requires shell fences to be tagged ```bash. This updates the three remaining offenders for consistency and correct syntax highlighting. No code inside the blocks changed.

Files:

  • docs/observability/logging.md
  • docs/kubernetes/model-caching-with-fluid.md
  • docs/kubernetes/cloud-providers/ecs/ecs.md

Validation

  • pre-commit run --files <the three files> passes.
  • rg '^```sh$' docs/ returns no matches after the change.

Related Issues

  • Confirmed — no related issue

Open in Devin Review

Summary by CodeRabbit

  • Documentation
    • Updated several command examples to use bash code block formatting for improved syntax highlighting and consistency.
    • No commands or user-facing behavior changed.

@cpakkamisaac-sae cpakkamisaac-sae requested a review from a team as a code owner June 29, 2026 21:55
@copy-pr-bot

copy-pr-bot Bot commented Jun 29, 2026

Copy link
Copy Markdown

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@devin-ai-integration devin-ai-integration 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.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Open in Devin Review

@cpakkamisaac-sae cpakkamisaac-sae force-pushed the cpakkamisaac/docs-bash-code-fences branch from e874c71 to 211774a Compare June 29, 2026 21:56
@cpakkamisaac-sae cpakkamisaac-sae temporarily deployed to external_collaborator June 29, 2026 21:56 — with GitHub Actions Inactive
@coderabbitai

coderabbitai Bot commented Jun 29, 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: 586b40ca-453f-4791-a0a1-f4f999a0eef6

📥 Commits

Reviewing files that changed from the base of the PR and between 727acaa and 211774a.

📒 Files selected for processing (3)
  • docs/kubernetes/cloud-providers/ecs/ecs.md
  • docs/kubernetes/model-caching-with-fluid.md
  • docs/observability/logging.md

Walkthrough

Three documentation files updated fenced code block language identifiers from sh to bash, affecting syntax highlighting labels only. No commands or content were changed.

Changes

Docs code fence updates

Layer / File(s) Summary
sh to bash code fence identifiers
docs/kubernetes/cloud-providers/ecs/ecs.md, docs/kubernetes/model-caching-with-fluid.md, docs/observability/logging.md
Opening fenced code block markers changed from sh to bash in three documentation files.

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 is concise and accurately describes the main change: switching shell code fences to bash.
Description check ✅ Passed The description covers the change, affected files, validation, and issue status, even though it doesn't use the template headings verbatim.
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.

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

@github-actions github-actions Bot added the docs label Jun 29, 2026
@github-actions

github-actions Bot commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

@github-actions github-actions Bot added external-contribution Pull request is from an external contributor documentation Improvements or additions to documentation labels Jun 29, 2026
@cpakkamisaac-sae cpakkamisaac-sae temporarily deployed to external_collaborator June 29, 2026 22:01 — with GitHub Actions Inactive
@cpakkamisaac-sae cpakkamisaac-sae force-pushed the cpakkamisaac/docs-bash-code-fences branch from 391f16c to 7561502 Compare June 29, 2026 22:02
@cpakkamisaac-sae cpakkamisaac-sae temporarily deployed to external_collaborator June 29, 2026 22:02 — with GitHub Actions Inactive
The documentation style guide requires shell code fences to be tagged
`bash` rather than `sh`. Update the three remaining `sh`-tagged fences
under docs/ for consistency and correct syntax highlighting.

Signed-off-by: Clement Pakkam Isaac <cpakkamisaac@nvidia.com>
@cpakkamisaac-sae cpakkamisaac-sae force-pushed the cpakkamisaac/docs-bash-code-fences branch from 7561502 to 0c53627 Compare June 29, 2026 22:04
@cpakkamisaac-sae cpakkamisaac-sae temporarily deployed to external_collaborator June 29, 2026 22:04 — with GitHub Actions Inactive
@cpakkamisaac-sae cpakkamisaac-sae temporarily deployed to external_collaborator June 29, 2026 22:05 — with GitHub Actions Inactive
@rmccorm4 rmccorm4 enabled auto-merge (squash) June 30, 2026 04:49
@rmccorm4

Copy link
Copy Markdown
Contributor

/ok to test 1ce8e02

@rmccorm4 rmccorm4 merged commit 8f2431e into ai-dynamo:main Jun 30, 2026
80 checks passed
@rmccorm4

Copy link
Copy Markdown
Contributor

Thanks for the contribution @cpakkamisaac-sae !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs documentation Improvements or additions to documentation external-contribution Pull request is from an external contributor size/XS

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants