Fix broken GH Markdown Callout in documentation#746
Fix broken GH Markdown Callout in documentation#746RyanGst wants to merge 3 commits intosipeed:mainfrom
Conversation
Removed redundant tip about Docker Gateway host settings.
Reinsert Docker usage tip for accessibility.
There was a problem hiding this comment.
Pull request overview
This PR fixes broken GitHub Markdown callout syntax in the documentation by moving TIP callouts from inside code blocks to outside them. GitHub Markdown callouts (using > [!TIP] syntax) need to be placed outside code fences to render properly. The fix is applied consistently across the main English README and its Portuguese and French translations.
Changes:
- Repositioned GitHub Markdown TIP callouts from inside Docker command code blocks to after the closing code fence in all three README files
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Moved TIP callout about Docker Gateway host configuration outside the code block |
| README.pt-br.md | Moved TIP callout about Docker Gateway host configuration outside the code block (Portuguese translation) |
| README.fr.md | Moved TIP callout about Docker Gateway host configuration outside the code block (French translation) |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
|
|
There was a problem hiding this comment.
There are two extra blank lines here that are not present in the corresponding sections of README.md and README.pt-br.md. For consistency across all three documentation files, these extra blank lines should be removed. The other README files have only one blank line after the TIP callout before the next section.
xiaket
left a comment
There was a problem hiding this comment.
LGTM, but do we need to also update the README for other languages?
nikolasdehor
left a comment
There was a problem hiding this comment.
Correct fix. GitHub Markdown callouts (> [!TIP]) must be placed outside of fenced code blocks (triple backticks) to render properly. Moving the callout after the closing ``` in all three READMEs fixes the rendering.
One minor nit: the French README adds an extra blank line at the end of the callout block (two blank lines after the callout), while the English and Portuguese versions do not. Cosmetic only.
LGTM.
📝 Description
🗣️ Type of Change
🤖 AI Code Generation
🔗 Related Issue
📚 Technical Context (Skip for Docs)
☑️ Checklist