docs: Update README with badges for resources#26
Conversation
Added badges for documentation, Discord, and Docker version.
|
Warning Rate limit exceeded
You’ve run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📝 WalkthroughWalkthroughREADME.md is updated with a centered badge section containing status links for Read the Docs, Discord, and Docker, while removing outdated configuration documentation entries for ChangesDocumentation Updates
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Suggested labels
🚥 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)
✨ Simplify code
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 |
There was a problem hiding this comment.
Pull request overview
Adds prominent badges to the repository README to surface key project resources (documentation, Discord community, and Docker image information), aligning with Issue #11’s request to make access to grimmory.org/docs more discoverable.
Changes:
- Added centered Shields.io badges for Docs, Discord, and Docker latest tag.
- Minor README formatting cleanup near the deploy setup section.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| <p align="center"> | ||
| <img src="https://img.shields.io/badge/Read%20the%20Docs-FB923C?style=for-the-badge&logo=readthedocs&link=https%3A%2F%2Fgrimmory.org%2Fdocs%2Fgetting-started" alt="Read the Docs"/> | ||
| <img src="https://img.shields.io/discord/1483208318720675860?style=for-the-badge&logo=discord&label=Join%20Discord&link=https%3A%2F%2Fdiscord.gg%2FvNsB8CTebs" alt="Join Discord"/> | ||
| <img src="https://img.shields.io/docker/v/grimmory/grimmory/latest?style=for-the-badge&label=Latest%20Version" alt="Latest Version"/> |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 1-5: The badges in README.md are non-clickable because they use
<img> tags with a non-functional `link` param; replace each badge image with a
clickable link by either wrapping each <img> in an <a href="...">...</a> tag
pointing to the correct URL (docs, Discord, Docker Hub) or convert the three
badges to Markdown link syntax ([](...)) and adjust centering (keep
the surrounding <p align="center"> if you want centered badges); update the
existing img entries shown in the diff so each points to its proper destination.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 70c800d2-591b-42fd-9126-71d85c755150
📒 Files selected for processing (1)
README.md
📜 Review details
🔇 Additional comments (1)
README.md (1)
35-36: Inconsistency: AI summary indicates these lines were removed, but they're still present.The AI-generated summary states that documentation entries for
url: https://grimmory.organdbaseUrl: /were removed, but these lines still appear in the code. If these are indeed outdated as the summary suggests, they should be removed; otherwise, the summary is incorrect.
b04b74a to
a9a1a3a
Compare
|
I'm open to feedback, and I'm happy to update them in the same format as the grimmory readme. It would be good to have an image if the smaller badges are desired. |

Description
Added badges for documentation, Discord, and Docker version.
Linked Issue
#11
Changes
:latestversion.Summary by CodeRabbit