Skip to content

Conversation

@mikemckiernan
Copy link
Collaborator

@mikemckiernan mikemckiernan commented Nov 7, 2025

Description

The doc file was misformatted and cause the page to render incorrectly.

The safe response in Hindi looks better now.

Related Issue(s)

Checklist

  • I've read the CONTRIBUTING guidelines.
  • I've updated the documentation if applicable.
  • I've added tests if applicable.
  • @mentions of the person or team responsible for reviewing proposed changes.

@mikemckiernan mikemckiernan self-assigned this Nov 7, 2025
@mikemckiernan mikemckiernan added the documentation Improvements or additions to documentation label Nov 7, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Nov 7, 2025

Documentation preview

https://nvidia-nemo.github.io/Guardrails/review/pr-1500

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

Greptile Overview

Greptile Summary

Fixed markdown rendering issues in the Nemotron Safety Guard deployment documentation by correcting code fence syntax and indentation.

  • Changed code fence from output to text for proper syntax highlighting
  • Fixed indentation for wrapped lines in Hindi example output to maintain proper formatting

Confidence Score: 5/5

  • This PR is completely safe to merge with no risk
  • Only cosmetic documentation formatting changes with no functional impact
  • No files require special attention

Important Files Changed

File Analysis

Filename Score Overview
docs/user-guides/advanced/nemotron-safety-guard-deployment.md 5/5 Fixed code fence syntax and indentation for multilingual example output

Sequence Diagram

sequenceDiagram
    participant Dev as Developer
    participant Doc as Documentation File
    participant Render as Doc Renderer
    participant User as End User
    
    Dev->>Doc: Update code fence: output → text
    Dev->>Doc: Fix indentation in Hindi example
    Doc->>Render: Process markdown
    Render->>Render: Parse code blocks correctly
    Render->>Render: Apply proper formatting
    Render->>User: Display properly formatted page
Loading

1 file reviewed, no comments

Edit Code Review Agent Settings | Greptile

@codecov
Copy link

codecov bot commented Nov 7, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

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

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants