Skip to content

Conversation

@akrem-chabchoub
Copy link
Contributor

@akrem-chabchoub akrem-chabchoub commented Oct 31, 2025

Checklist

  • I have read the coding guide.
  • My change requires a documentation update, and I have done it.
  • I have added tests to cover my changes.
  • I have filled out the description and linked the related issues.

Description

Fix docker readme mardown issues by:

  • Adding bash and yaml language identifiers to code blocks
  • Adding blank lines before and after fenced code blocks
  • Adding blank lines around list items and headings

Open API Spec Version Changes (if applicable)

Motivation and Context (Optional)

Related Issue (Optional)

#5272

Screenshots (if appropriate):

Before the changes:

image

Copilot AI review requested due to automatic review settings October 31, 2025 11:16
@akrem-chabchoub akrem-chabchoub changed the title docs(docker): format code blocks for better readability docs(docker-readme): format and fix code blocks to prevent warnings Oct 31, 2025
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 enhances the documentation formatting in the Docker README by adding language specifiers to code blocks and improving readability with additional blank lines. The changes make the documentation more accessible and enable proper syntax highlighting.

Key changes:

  • Added language identifiers (bash, yaml) to all code blocks for syntax highlighting
  • Inserted blank lines before code blocks to improve visual separation and readability

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@akrem-chabchoub akrem-chabchoub self-assigned this Oct 31, 2025
@akrem-chabchoub akrem-chabchoub linked an issue Oct 31, 2025 that may be closed by this pull request
@gacevicljubisa gacevicljubisa merged commit 4e2afdf into master Nov 3, 2025
27 of 36 checks passed
@gacevicljubisa gacevicljubisa deleted the docs/docker branch November 3, 2025 10:15
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.

Fix Markdown formatting in Docker README

4 participants