Skip to content

Conversation

MayaSatishRao
Copy link

What type of PR is this? (Check all that apply)

  • 🛠 Refactor
  • ✨ Feature
  • 🐛 Bug Fix
  • ⚡ Optimization
  • 📝 Documentation Update

Description

Summary
This PR fixes the broken "Contributing" link in the README’s Table of Contents.
The issue occurred because the emoji (⚒️) in the section heading introduced a hidden Unicode variation selector, causing GitHub to generate an encoded anchor (#%EF%B8%8F-contributing) that didn’t match the Markdown link.

Changes Made

  • Updated the ## ⚒️ Contributing heading to include a stable custom ID ().
  • Updated the Table of Contents link to use #contributing for consistent behavior across Markdown renderers.
  • Verified that all ToC links now work correctly on GitHub.

Related Tickets & Documents

How to reproduce the issue

  • Open the main README.md file on GitHub.
  • Click on the “Contributing” entry in the Table of Contents.
    Observe that the link fails to scroll to the corresponding section.

Backporting

This change should be backported to:

  • 3.0
  • 3.1
  • 4.0
  • [ x] develop

Checklist

We encourage keeping the code coverage percentage at 80% or above.

  • ✅ This solution meets the acceptance criteria of the related issue.
  • [ x] 📝 The related issue checklist is completed.
  • 🧪 This PR includes unit tests for the developed code.
    If not, explain why: documentation pr, hence unit test not required
  • 🔄 End-to-End tests have been added or updated.
    If not, explain why: documentation pr, hence E2E test not required
  • 📚 The documentation has been updated, or a dedicated issue has been created.
    If not, explain why:
  • 📌 The release notes have been updated.
    If not, explain why: documentation pr, hence update to release notes not required

Copy link
Contributor

@trgiangdo trgiangdo left a comment

Choose a reason for hiding this comment

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

This doesn't fix the problem. The problem was with the unicode of the #

Does it work in your environment?

@MayaSatishRao
Copy link
Author

@trgiangdo Yes, it’s working fine on my local setup, and I’ve also tested it on a few online Markdown editors. The issue seems to be with the emoji ⚒️ — its Unicode (U+2692 U+FE0F) consists of two parts, which is causing the anchor link problem. I’ve resolved this by adding an explicit anchor tag, which fixes the issue.

@trgiangdo
Copy link
Contributor

I see. It does seem to work in Github markdown preview

@FabienLelaquais @jrobinAV Please let me know what you think

- [Quickstart](#-quickstart)
- [Documentation and resources](#-documentation-and-resources)
- [Contributing](#-contributing)
- [Contributing](#contributing)
Copy link
Member

Choose a reason for hiding this comment

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

for consistency sake, would it be better to make the id start with a dash "-" ?
@FabienLelaquais what do you think ?

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.

[📄 DOCS] Broken “Contributing” link in README Table of Contents

3 participants