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

[mxsm]

Which Issue(s) This PR Fixes(Closes)

Fixes #5562

Brief Description

How Did You Test This Change?

Summary by CodeRabbit

• Documentation
  • Updated README navigation header from text-based links to a badge-based design layout, maintaining all existing navigation functionality and section references.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[rocketmq-rust-bot]

🔊@mxsm 🚀Thanks for your contribution🎉！

💡CodeRabbit(AI) will review your code first🔥！

Note

🚨The code review suggestions from CodeRabbit are to be used as a reference only, and the PR submitter can decide whether to make changes based on their own judgment. Ultimately, the project management personnel will conduct the final code review💥.

[coderabbitai]

Walkthrough

Replaces text-based navigation links in README.md with visual shield badges, maintaining existing section semantics and anchors. Changes presentation from centered text links to badge-based header format.

Changes

Cohort / File(s)	Summary
README Navigation Enhancement README.md	Converts text-based centered navigation links into a visual badge-based header using shields badges. Updates lines +24/-5 while preserving section structure and anchor links.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 Badges bright, shields glow with pride,
Navigation now has visual stride,
README's face gets a makeover true,
Fancy badges make it shine right through! ✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly describes the main change: updating README.md with badge links to enhance visual appeal and navigation, which aligns with the actual file modifications.
Linked Issues check	✅ Passed	The changes directly implement the objective from #5562 to enhance README.md visual appeal and navigation by adding badge links for key sections.
Out of Scope Changes check	✅ Passed	All changes are scoped to README.md formatting and presentation updates aligned with the linked issue objective; no extraneous modifications detected.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In @README.md:
- Around line 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.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0c28fd0 and c17183a.

📒 Files selected for processing (1)

• README.md

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)

• GitHub Check: Build & Test (macos-latest)
• GitHub Check: Build & Test (ubuntu-latest)
• GitHub Check: Build & Test (windows-latest)
• GitHub Check: Code Coverage
• GitHub Check: auto-approve

[coderabbitai]

⚠️ 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.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 38.53%. Comparing base (0c28fd0) to head (c17183a).
⚠️ Report is 4 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #5563      +/-   ##
==========================================
- Coverage   38.54%   38.53%   -0.01%     
==========================================
  Files         816      816              
  Lines      110917   110917              
==========================================
- Hits        42748    42746       -2     
- Misses      68169    68171       +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[rocketmq-rust-bot]

LGTM - All CI checks passed ✅