Skip to content

docs: fix broken Table of Contents anchor links by removing emoji remnants#49

Open
Mohit-001-hash wants to merge 1 commit into
kanak227:mainfrom
Mohit-001-hash:fix-toc-links
Open

docs: fix broken Table of Contents anchor links by removing emoji remnants#49
Mohit-001-hash wants to merge 1 commit into
kanak227:mainfrom
Mohit-001-hash:fix-toc-links

Conversation

@Mohit-001-hash

@Mohit-001-hash Mohit-001-hash commented Jun 24, 2026

Copy link
Copy Markdown

📝 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):

  • Bug fix
  • New feature
  • Enhancement
  • Documentation update
  • Refactoring
  • Test addition
  • Performance improvement

🧪 How Has This Been Tested?

No tests required (Documentation only).

📸 Screenshots / GIFs (if applicable)

None

✅ Checklist

  • My code follows the project's coding style.
  • I have tested my changes locally.
  • I have updated the documentation if necessary.
  • My changes do not break existing functionality.
  • I have linked the related issue.
  • I have resolved any merge conflicts.

📌 Additional Notes

None

Summary by CodeRabbit

  • Documentation
    • Corrected and standardized the Table of Contents links in the README.
    • Fixed section anchor formatting so links now jump to the intended headings.

@coderabbitai

coderabbitai Bot commented Jun 24, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: f47c60ee-3121-4215-b212-cc675b7a2457

📥 Commits

Reviewing files that changed from the base of the PR and between f85017c and 853f077.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

The Table of Contents in README.md had malformed anchor targets (e.g., #-overview, #-system-architecture). Lines 26–38 are updated so each bullet link points to the correct section heading anchor.

Changes

README Table of Contents Fix

Layer / File(s) Summary
ToC anchor targets corrected
README.md
Replaces malformed anchor targets (prefixed with #-) in the Table of Contents bullet list with correctly formatted anchors matching the actual section headings.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A rabbit hopped through links one day,
Found anchors broken, gone astray.
She snipped the dashes, set them right,
The Table of Contents now shines bright! 🐇✨
No more #- to cause a fright!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly matches the main change: fixing broken README Table of Contents anchor links.
Description check ✅ Passed The description follows the template and includes all required sections with a clear documentation-only summary.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

Comment @coderabbitai help to get the list of available commands.

@kanak227

Copy link
Copy Markdown
Owner

are you a contributor of GSSOC?

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