Conversation
minor fix
Review Summary by QodoFix broken Contributing link in README navigation
WalkthroughsDescription• Fix broken documentation link in README navigation • Update Contributing section reference from Development Diagramflowchart LR
A["README.md"] -- "Update link reference" --> B["Development → Contributing"]
File Changes1. README.md
|
Code Review by Qodo🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0) 📐 Spec deviations (0)
Great, no issues found!Qodo reviewed your code and found no material issues that require reviewⓘ The new review experience is currently in Beta. Learn more |
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request addresses a minor documentation issue by correcting an internal link within the Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
📝 WalkthroughWalkthroughREADME.md navigation link updated: the "Quick Paths" section reference changed from Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~1 minute Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
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 Tip CodeRabbit can use TruffleHog to scan for secrets in your code with verification capabilities.Add a TruffleHog config file (e.g. trufflehog-config.yml, trufflehog.yml) to your project to customize detectors and scanning behavior. The tool runs only when a config file is present. |
![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 aims to fix a link in the README.md file. However, the new link to the 'Contributing' section is also incorrect due to a malformed anchor. I have provided a suggestion to correct the link to ensure it functions as intended.
| > - 🐍 **Python SDK?** → [Python Examples](#-using-python-code) | ||
| > - 🎯 **CLI user?** → [CLI Quick Reference](#cli-quick-reference) | ||
| > - 🤝 **Contributing?** → [Development](#-development) | ||
| > - 🤝 **Contributing?** → [Contributing](#-contributing) |
There was a problem hiding this comment.
The anchor link to the 'Contributing' section is incorrect. For a heading like ## 👥 Contributing, the correct anchor is #contributing. The current link #-contributing will not work as it contains an extra hyphen.
| > - 🤝 **Contributing?** → [Contributing](#-contributing) | |
| > - 🤝 **Contributing?** → [Contributing](#contributing) |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Line 47: Update the broken markdown anchor links that include a leading
hyphen: replace instances like `[Contributing](`#-contributing`)` with
`[Contributing](`#contributing`)` and likewise change `[Quick
Start](`#-quick-start`)`, `[Installation](`#-installation`)`, and `[Using Python
code](`#-using-python-code`)` to remove the `-` so they become `#quick-start`,
`#installation`, and `#using-python-code` respectively; ensure the anchor text
matches the actual header text (e.g., `## 👥 Contributing`, `## 🚀 Quick Start`,
etc.) so GitHub-generated anchors resolve correctly.
| > - 🐍 **Python SDK?** → [Python Examples](#-using-python-code) | ||
| > - 🎯 **CLI user?** → [CLI Quick Reference](#cli-quick-reference) | ||
| > - 🤝 **Contributing?** → [Development](#-development) | ||
| > - 🤝 **Contributing?** → [Contributing](#-contributing) |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Description: Verify the correct anchor format and check for other references to `#development`
echo "=== Testing anchor formats ==="
echo "Checking if standard GitHub anchor patterns are used..."
# Check all navigation links in Quick Paths section
echo -e "\n=== Quick Paths navigation links ==="
rg -n "Quick Paths" -A 10 README.md
# Search for any remaining references to `#development` or "development" section
echo -e "\n=== Searching for 'development' references ==="
rg -i "development" README.md
# Check the actual Contributing section heading
echo -e "\n=== Contributing section heading ==="
rg -n "^## .*Contributing" README.md
# Check if there are other internal links in the README to compare anchor patterns
echo -e "\n=== Other internal markdown links for pattern comparison ==="
rg -n "\[.*\]\(#.*\)" README.md | head -20Repository: MervinPraison/PraisonAI
Length of output: 1812
🌐 Web query:
GitHub markdown anchor generation emoji handling heading formatting
💡 Result:
GitHub generates Markdown heading anchors (for section links like #header) using these rules from official docs, applied to the rendered text content of the heading: - Remove markup formatting (e.g., italics -> italics, code spans removed). - Trim leading/trailing whitespace. - Replace spaces with hyphens (-). - Remove other whitespace/punctuation. - Convert letters to lowercase. - If duplicate, append -2, -3, etc. Emojis (Unicode or :code:) are handled as follows in anchor generation: - Unicode emojis (e.g., 📦) are ignored/removed; they do not appear in the anchor slug. Example: # Modules 📦 generates #modules- (dash for space). - Emoji shortcodes (e.g., 📦) are converted to the emoji image by EmojiFilter (before TOCFilter), then removed like Unicode emojis. To link correctly, omit emojis from manual anchor links, using only the text parts slugified per rules. GitHub's TOCFilter in html-pipeline generates matching anchors by extracting .text_content (strips tags/images), then slugifying.
Citations:
- 1: https://docs.github.com/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax
- 2: Emoji in header breaks generated link thlorenz/anchor-markdown-header#36
- 3: Is it possible to hyperlink with emoji? github/markup#1231
- 4: https://docs.github.com/en/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax
Fix the broken anchor link to the Contributing section.
The link target #-contributing is incorrect. GitHub markdown removes Unicode emojis when generating anchors, so ## 👥 Contributing produces the anchor #contributing, not #-contributing. The link should be changed to [Contributing](#contributing).
Additionally, lines 43-45 appear to use the same incorrect #- anchor pattern (#-quick-start, #-installation, #-using-python-code), which should also be corrected to match the actual generated anchors.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` at line 47, Update the broken markdown anchor links that include a
leading hyphen: replace instances like `[Contributing](`#-contributing`)` with
`[Contributing](`#contributing`)` and likewise change `[Quick
Start](`#-quick-start`)`, `[Installation](`#-installation`)`, and `[Using Python
code](`#-using-python-code`)` to remove the `-` so they become `#quick-start`,
`#installation`, and `#using-python-code` respectively; ensure the anchor text
matches the actual header text (e.g., `## 👥 Contributing`, `## 🚀 Quick Start`,
etc.) so GitHub-generated anchors resolve correctly.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1119 +/- ##
==========================================
- Coverage 14.24% 13.29% -0.95%
==========================================
Files 25 629 +604
Lines 2717 93343 +90626
Branches 389 0 -389
==========================================
+ Hits 387 12414 +12027
- Misses 2314 80929 +78615
+ Partials 16 0 -16
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
1 participant
minor fix
Summary by CodeRabbit