docs: fix broken Table of Contents anchor links by removing emoji remnants#49
docs: fix broken Table of Contents anchor links by removing emoji remnants#49Mohit-001-hash wants to merge 1 commit into
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe Table of Contents in ChangesREADME Table of Contents Fix
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
|
are you a contributor of GSSOC? |
📝 Description
This PR resolves a navigation friction point in the README. Currently, all links in the Table of Contents are broken. GitHub's Markdown parser automatically strips emojis and special characters when generating header anchor IDs, but the TOC links included leftover hyphens and emoji artifacts (e.g.,
#-overview). I updated the TOC anchor links to correctly match the standard paths generated by GitHub (e.g.,#overview), ensuring that users can successfully click and jump to the relevant sections.🔗 Related Issue
Closes #None (just a documentation fix)
📂 Type of Change
Please check the relevant option(s):
🧪 How Has This Been Tested?
No tests required (Documentation only).
📸 Screenshots / GIFs (if applicable)
None
✅ Checklist
📌 Additional Notes
None
Summary by CodeRabbit