Skip to content

docs: Update README with badges for resources#26

Open
Milhound wants to merge 2 commits into
grimmory-tools:mainfrom
Milhound:docs/badges
Open

docs: Update README with badges for resources#26
Milhound wants to merge 2 commits into
grimmory-tools:mainfrom
Milhound:docs/badges

Conversation

@Milhound
Copy link
Copy Markdown
Contributor

@Milhound Milhound commented May 9, 2026

Description

Added badges for documentation, Discord, and Docker version.

Linked Issue

#11

Changes

  • Added links for Docs, Discord, Docker tag :latest version.

Summary by CodeRabbit

  • Documentation
    • Added status and reference badges to the top of the README for improved visibility
    • Removed outdated documentation entries from the README

Added badges for documentation, Discord, and Docker version.
Copilot AI review requested due to automatic review settings May 9, 2026 03:22
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 9, 2026

Review Change Stack

Warning

Rate limit exceeded

@Milhound has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 42 minutes and 41 seconds before requesting another review.

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 @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 55bf8351-3ce3-43f0-aa59-837f2db3070c

📥 Commits

Reviewing files that changed from the base of the PR and between 52acc9d and 2683a75.

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

Walkthrough

README.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 url and baseUrl values.

Changes

Documentation Updates

Layer / File(s) Summary
Badges Section
README.md
Centered HTML block with Shields.io badges for Read the Docs, Discord, and Docker latest version added at the top.
Configuration Documentation Cleanup
README.md
Removed documentation entries for url: https://grimmory.org and baseUrl: / configuration values.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Suggested labels

enhancement

A splash of badges bright and new, 🎖️
Like shields of honor, shining through,
Old config lines bid them adieu,
The README sparkles, fresh and true! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The pull request title follows the conventional commit format with a clear scope and description of the changes.
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
✨ Simplify code
  • Create PR with simplified 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.

❤️ Share

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

@Milhound Milhound changed the title Update README with badges for resources docs: Update README with badges for resources May 9, 2026
@coderabbitai coderabbitai Bot added the enhancement New feature or request label May 9, 2026
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.

Comment thread README.md Outdated
Comment on lines +1 to +4
<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"/>
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3d93a53 and 52acc9d.

📒 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.org and baseUrl: / 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.

Comment thread README.md
@Milhound Milhound force-pushed the docs/badges branch 2 times, most recently from b04b74a to a9a1a3a Compare May 9, 2026 03:37
@Milhound
Copy link
Copy Markdown
Contributor Author

Milhound commented May 9, 2026

image

@Milhound
Copy link
Copy Markdown
Contributor Author

Milhound commented May 9, 2026

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants