Readme improvements - #216
Merged
Merged
Conversation
Owen-3456
commented
Mar 13, 2026
Owen-3456
commented
Contributor
- Consolidate badges on single lines
- Convert bullet points to markdown format
- Add proper syntax highlighting to code blocks (bash/yml)
- Improve screenshot layout
- Convert HTML info box to markdown blockquote
- Fix Docker Compose indentation and formatting
- Improve table alignment and consistency
- Consolidate badges on single lines - Convert bullet points to markdown format - Add proper syntax highlighting to code blocks (bash/yml) - Improve screenshot layout with responsive 2x2 grid - Convert HTML info box to markdown blockquote - Fix Docker Compose indentation and formatting - Improve table alignment and consistency
Contributor
There was a problem hiding this comment.
Pull request overview
Documentation-focused update to the project README to improve formatting, readability, and presentation (badges, screenshots, code blocks, and tables).
Changes:
- Reformats screenshots into a grid-style layout and replaces an HTML “info” box with a Markdown blockquote.
- Adds language identifiers to code blocks and reformats Docker/Docker Compose snippets.
- Normalizes Markdown lists/tables and improves general README consistency.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Owen-3456
force-pushed
the
README-improvements
branch
from
March 13, 2026 12:39
c239ce9 to
9451efd
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.