Skip to content

Fix broken GH Markdown Callout in documentation#746

Open
RyanGst wants to merge 3 commits intosipeed:mainfrom
RyanGst:patch-1
Open

Fix broken GH Markdown Callout in documentation#746
RyanGst wants to merge 3 commits intosipeed:mainfrom
RyanGst:patch-1

Conversation

@RyanGst
Copy link

@RyanGst RyanGst commented Feb 25, 2026

📝 Description

🗣️ Type of Change

  • 🐞 Bug fix (non-breaking change which fixes an issue)
  • ✨ New feature (non-breaking change which adds functionality)
  • 📖 Documentation update
  • ⚡ Code refactoring (no functional changes, no api changes)

🤖 AI Code Generation

  • 🤖 Fully AI-generated (100% AI, 0% Human)
  • 🛠️ Mostly AI-generated (AI draft, Human verified/modified)
  • 👨‍💻 Mostly Human-written (Human lead, AI assisted or none)

🔗 Related Issue

📚 Technical Context (Skip for Docs)

  • Reference URL:
  • Reasoning:

☑️ Checklist

  • My code/docs follow the style of this project.
  • I have performed a self-review of my own changes.
  • I have updated the documentation accordingly.

Removed redundant tip about Docker Gateway host settings.
Reinsert Docker usage tip for accessibility.
Copilot AI review requested due to automatic review settings February 25, 2026 00:08
@RyanGst RyanGst mentioned this pull request Feb 25, 2026
10 tasks
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.

Comment on lines +184 to +185


Copy link

Copilot AI Feb 25, 2026

Choose a reason for hiding this comment

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

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.

Suggested change

Copilot uses AI. Check for mistakes.
Copy link
Collaborator

@xiaket xiaket left a comment

Choose a reason for hiding this comment

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

LGTM, but do we need to also update the README for other languages?

@xiaket xiaket added the documentation Improvements or additions to documentation label Feb 25, 2026
Copy link

@nikolasdehor nikolasdehor left a comment

Choose a reason for hiding this comment

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

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.

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.

4 participants