Skip to content

[ISSUE #5562]📝Update README.md to enhance visual appeal and navigation with badge links for key sections #5563

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.

Sign up for GitHub

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

Merged
rocketmq-rust-bot merged 1 commit into from
Jan 8, 2026
Merged

[ISSUE #5562]📝Update README.md to enhance visual appeal and navigation with badge links for key sections #5563

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 24 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,30 @@

🚀 A high-performance, reliable, and feature-rich **unofficial Rust implementation** of [Apache RocketMQ](https://github.com/apache/rocketmq), designed to bring enterprise-grade message middleware to the Rust ecosystem.

<div align="center">

**[ 📖 [Overview](#-overview) | 🚀 [Quick Start](#-quick-start) | 📚 [Documentation](#-documentation) | 📦 [Components](#-components--crates) | 🗺️ [Roadmap](#-roadmap) | 🤝 [Contributing](#-contributing) | 👥 [Community](#-community--support) ]**

</div>
<p align="center">
<a href="#-overview">
<img src="https://img.shields.io/badge/📖_Overview-4A90E2?style=flat-square&labelColor=2C5F9E&color=4A90E2" alt="Overview">
</a>
<a href="#-quick-start">
<img src="https://img.shields.io/badge/🚀_Quick_Start-50C878?style=flat-square&labelColor=2D7A4F&color=50C878" alt="Quick Start">
</a>
<a href="#-documentation">
<img src="https://img.shields.io/badge/📚_Documentation-FF8C42?style=flat-square&labelColor=CC6A2F&color=FF8C42" alt="Documentation">
</a>
<a href="#-components--crates">
<img src="https://img.shields.io/badge/📦_Components-9B59B6?style=flat-square&labelColor=6C3483&color=9B59B6" alt="Components">
</a>
<br/>
<a href="#-roadmap">
<img src="https://img.shields.io/badge/🗺️_Roadmap-E74C3C?style=flat-square&labelColor=B03A2E&color=E74C3C" alt="Roadmap">
</a>
<a href="#-contributing">
<img src="https://img.shields.io/badge/🤝_Contributing-F39C12?style=flat-square&labelColor=B9770E&color=F39C12" alt="Contributing">
</a>
<a href="#-community--support">
<img src="https://img.shields.io/badge/👥_Community-8E44AD?style=flat-square&labelColor=633974&color=8E44AD" alt="Community">
</a>
</p>
Comment on lines +28 to +51
Copy link
Contributor

@coderabbitai coderabbitai bot Jan 8, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Verify badge anchor links match section headers in README.md

echo "=== All Section Headers in README.md ==="
rg -n '^##\s+' README.md

echo ""
echo "=== Badge Navigation Links from Lines 28-51 ==="
sed -n '28,51p' README.md | grep -oP 'href="#\K[^"]+'

echo ""
echo "=== Checking for anchor-like sections that might be generated by GitHub ==="
rg -n '^##\s+' README.md | sed 's/^[0-9]*:\s*##\s*//' | sed 's/[[:space:]]*$//' | while read header; do
  # Convert to GitHub anchor format (lowercase, spaces to hyphens, remove special chars)
  anchor=$(echo "$header" | tr '[:upper:]' '[:lower:]' | sed 's/[^a-z0-9 -]//g' | sed 's/[[:space:]]\+/-/g' | sed 's/^-//;s/-$//')
  echo "Header: '$header' -> Anchor: '#-$anchor'"
done

Repository: mxsm/rocketmq-rust

Length of output: 1326

Fix two broken badge anchor links

The visual navigation enhancement is excellent, but two badge links will not resolve correctly:

  • #-components--crates should be #-components-crates (single dash, not double)
  • #-community--support should be #-community-support (single dash, not double)

GitHub's anchor ID generation converts spaces to single hyphens. Update these two href values in the badge section to match the actual generated anchors from their respective section headers.

🤖 Prompt for AI Agents 
In @README.md around lines 28 - 51, Update the two broken badge hrefs in the
README badge block: change the anchor href value "#-components--crates" to
"#-components-crates" and change "#-community--support" to "#-community-support"
so they match GitHub's generated anchors for the "Components / Crates" and
"Community / Support" section headers; edit the href attributes in the badge
anchor elements shown in the diff to use the single-dash anchors.


---

Expand Down
Loading