-
Notifications
You must be signed in to change notification settings - Fork 255
Jbrejner/markdownfix #152
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Jbrejner/markdownfix #152
Conversation
There was a problem hiding this 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 pull request introduces significant improvements to documentation formatting, consistency, and clarity across the Docker tutorial repository. The changes focus on standardizing markdown formatting with linting rules, improving code block syntax highlighting, and enhancing overall readability for beginners.
- Added markdown linting configuration to enforce consistent style guidelines
- Standardized all code blocks to include proper language specification for syntax highlighting
- Enhanced readability through improved line breaks, sentence structure, and terminology consistency
Reviewed Changes
Copilot reviewed 46 out of 46 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| .markdownlint.json | Adds markdown linting configuration with line length and HTML element rules |
| README.md | Improves structure and formatting with better headers and line breaks |
| CHEATSHEET.md | Enhances readability with proper formatting and source attribution |
| labs/* files | Standardizes code blocks with language tags and improves text formatting |
| trainer/* files | Fixes typos, improves formatting, and adds proper code block languages |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| @@ -1,14 +1,15 @@ | |||
| # Empty image (useles, but really empty) | |||
| # Empty image (useless, but really empty) | |||
Copilot
AI
Aug 21, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed the typo 'useles' to 'useless' which improves readability and professionalism of the documentation.
Copilot uses AI. Check for mistakes.
| Try to build your application container and open browser to correct port. | ||
|
|
||
| _*Q: What do you see on <domain>:<port>/hello/docker-is-awesome ?*_ | ||
| _*Q: What do you see on <domain>:<port>/hello/docker-is-awesome ?*_ |
Copilot
AI
Aug 21, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The URL is malformed with HTML entities and missing closing angle bracket. Should be <domain>:<port>/hello/docker-is-awesome with proper formatting.
| _*Q: What do you see on <domain>:<port>/hello/docker-is-awesome ?*_ | |
| _*Q: What do you see on <domain>:<port>/hello/docker-is-awesome?*_ |
Copilot uses AI. Check for mistakes.
This pull request introduces improvements to documentation formatting, consistency, and clarity across several markdown files in the Docker tutorial. The changes focus on standardizing code blocks, enhancing readability, and aligning terminology usage, making the tutorial easier to follow for beginners.
Documentation formatting and linting:
.markdownlint.jsonconfiguration file to enforce consistent markdown style, including line length and allowed inline HTML elements (details,summary).labs/01-hello-world.md,labs/02-running-images.md,labs/03-deletion.md) to specify the language (e.g.,bash) for improved syntax highlighting and consistency. [1] [2] [3] [4]Clarity and readability improvements:
CHEATSHEET.md,README.md,labs/00-getting-started.md,labs/01-hello-world.md,labs/02-running-images.md,labs/03-deletion.md) to use line breaks and clearer phrasing, making instructions and explanations easier to read. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11]README.mdto better guide users through the tutorial steps.Terminology and instructional consistency:
These updates make the documentation more approachable and maintainable for future contributors.