Skip to content

docs: format README for consistent Markdown style#10551

Open
skant7 wants to merge 1 commit into
apache:developfrom
skant7:docs/format-readme
Open

docs: format README for consistent Markdown style#10551
skant7 wants to merge 1 commit into
apache:developfrom
skant7:docs/format-readme

Conversation

@skant7

@skant7 skant7 commented Jun 26, 2026

Copy link
Copy Markdown

Summary

  • Normalize horizontal rules to --- and spacing around section headings
  • Add blank lines before fenced code blocks and after intro lines for consistent Markdown rendering
  • Use consistent * list markers (including Windows setup steps) and 2-space nested list indentation for remoting clients
  • Remove extra blank lines and trailing whitespace

Content (links, versions, commands, community projects) is unchanged.

Test plan

  • Visual review of README.md diff for formatting-only changes
  • Confirm GitHub renders headings, lists, and code blocks correctly on the PR files tab

Normalize horizontal rules, blank lines around headings and code
blocks, list markers, nested list indentation, and trailing whitespace
without changing content.

@RockteMQ-AI RockteMQ-AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Review by github-manager-bot

Summary

Pure Markdown formatting cleanup of README.md — normalizes horizontal rules, adds blank lines before fenced code blocks, unifies list markers to *, and fixes nested list indentation. No content changes.

Findings

  • [Info] README.md:34 — Horizontal rule normalized from ----------- (variable length) to ---. Good consistency improvement.
  • [Info] README.md:46,65,75,86 — Blank lines added before fenced code blocks. This follows CommonMark spec recommendation and improves rendering consistency across Markdown parsers.
  • [Info] README.md:88-92 — Windows setup steps changed from - to * list markers for consistency with the rest of the document. Good.
  • [Info] README.md:93-97 — Nested list indentation changed from tab to 2-space. This is the correct approach for nested lists in CommonMark.

Assessment

Looks good. All changes are formatting-only with no content modifications. The PR improves Markdown consistency and rendering quality. The diff is clean and easy to verify.

Suggestions

  • Minor: consider adding a .markdownlint or .editorconfig config to enforce these formatting rules going forward and prevent future inconsistencies. This is optional and out of scope for this PR.

Automated review by github-manager-bot

@RockteMQ-AI RockteMQ-AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Review by github-manager-bot

Summary

Formats the README.md for consistent Markdown style: removes extra blank lines, adds blank lines before fenced code blocks (per CommonMark spec), converts Windows instructions from dash-list to asterisk-list, and normalizes the horizontal rule.

Findings

  • [Info] README.md — All changes are purely cosmetic/formatting. No content is added or removed.
  • [Info] Adding blank lines before fenced code blocks is correct per CommonMark/GFM spec — some renderers require it for proper parsing.
  • [Info] Converting the Windows steps from - items to * items improves consistency with the rest of the document.

Suggestions

  • No functional concerns. One minor note: the horizontal rule change from ----------- to --- is purely stylistic — both render identically in most Markdown parsers.

Verdict

Clean formatting improvement. LGTM.


Automated review by github-manager-bot

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.

2 participants