docs: fix README anchor links - #628
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe PR updates README.md navigation and mascot-block links to use revised non-emoji fragment identifiers. ChangesREADME Anchor Update
Estimated code review effort: 1 (Trivial) | ~3 minutes Possibly related PRs
Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ 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 |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request simplifies the anchor links in the README.md table of contents by removing emojis from the link targets and adding corresponding HTML anchor tags before each heading. The reviewer pointed out that GitHub Flavored Markdown (GFM) automatically generates these anchor IDs by converting heading text to lowercase, replacing spaces with hyphens, and stripping emojis/special characters. Therefore, the added HTML anchor tags are redundant and can be safely removed to keep the Markdown clean.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
| <a id="installation"></a> | ||
|
|
There was a problem hiding this comment.
GitHub Flavored Markdown (GFM) automatically generates anchor IDs for headings by converting the text to lowercase, replacing spaces with hyphens, and stripping emojis/special characters. Therefore, headings like ## 📦 Installation automatically get the ID installation. The added <a id="installation"></a> tag is redundant and can be safely removed to keep the Markdown clean.
| <a id="usage"></a> | ||
|
|
There was a problem hiding this comment.
GitHub Flavored Markdown (GFM) automatically generates anchor IDs for headings by converting the text to lowercase, replacing spaces with hyphens, and stripping emojis/special characters. Therefore, headings like ## 🚀 Usage automatically get the ID usage. The added <a id="usage"></a> tag is redundant and can be safely removed to keep the Markdown clean.
| <a id="chunkers"></a> | ||
|
|
There was a problem hiding this comment.
GitHub Flavored Markdown (GFM) automatically generates anchor IDs for headings by converting the text to lowercase, replacing spaces with hyphens, and stripping emojis/special characters. Therefore, headings like ## ✂️ Chunkers automatically get the ID chunkers. The added <a id="chunkers"></a> tag is redundant and can be safely removed to keep the Markdown clean.
| <a id="integrations"></a> | ||
|
|
There was a problem hiding this comment.
GitHub Flavored Markdown (GFM) automatically generates anchor IDs for headings by converting the text to lowercase, replacing spaces with hyphens, and stripping emojis/special characters. Therefore, headings like ## 🔌 Integrations automatically get the ID integrations. The added <a id="integrations"></a> tag is redundant and can be safely removed to keep the Markdown clean.
| <a id="benchmarks"></a> | ||
|
|
There was a problem hiding this comment.
GitHub Flavored Markdown (GFM) automatically generates anchor IDs for headings by converting the text to lowercase, replacing spaces with hyphens, and stripping emojis/special characters. Therefore, headings like ## 📊 Benchmarks automatically get the ID benchmarks. The added <a id="benchmarks"></a> tag is redundant and can be safely removed to keep the Markdown clean.
| <a id="acknowledgements"></a> | ||
|
|
There was a problem hiding this comment.
GitHub Flavored Markdown (GFM) automatically generates anchor IDs for headings by converting the text to lowercase, replacing spaces with hyphens, and stripping emojis/special characters. Therefore, headings like ## 🙏 Acknowledgements automatically get the ID acknowledgements. The added <a id="acknowledgements"></a> tag is redundant and can be safely removed to keep the Markdown clean.
There was a problem hiding this comment.
Pull request overview
This PR updates README internal navigation links so the top “Installation / Usage / Chunkers / Integrations / Benchmarks” links correctly jump to their corresponding sections.
Changes:
- Updated top navigation links to use simplified fragments (e.g.,
#installation,#usage). - Added explicit HTML anchor tags (
<a id="..."></a>) above key section headings to match those fragments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| <a id="installation"></a> | ||
|
|
| <a id="usage"></a> | ||
|
|
| <a id="chunkers"></a> | ||
|
|
| <a id="integrations"></a> | ||
|
|
| <a id="benchmarks"></a> | ||
|
|
| <a id="acknowledgements"></a> | ||
|
|
|
I just checked that suggestions from gemini and copilot seems not to work, so my solution seems to stands right now |
| <a id="installation"></a> | ||
|
|
There was a problem hiding this comment.
instead of adding new <a>, why not get the original links from the readme, after you click each section they will appear in the url in the page above, example for installation it should be : #-installation
There was a problem hiding this comment.
Uh yeah makes sense, just pushed the fix.
One note about the ## ✂️ Chunkers link: that particular emoji doesn't let the plain #-chunkers work (it leaves an invisible character in the generated slug), so Claude resolved it as #%EF%B8%8F-chunkers. Tested and it works now, thanks!
4d40105 to
8de18c5
Compare
Hi! Thanks for your work maintaining this library.
This is just a small README update to the internal links in the top navigation that currently are not redirecting to the correct sections.
Summary by CodeRabbit