✏️(docs) Add Add DPG badge to README#2440
Conversation
WalkthroughThe README gains one new badge in its top banner section: an anchor linking to Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes 🚥 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)
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 |
|
Thanks @BolajiAyodeji I just launched the CI. |
|
All should be fixed now @virgile-dev; thanks! |
This PR includes the new DPG badge in the README file and links to LaSuite Doc's profile page on the DPG Registry.
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 20-22: The DPG badge link and image were added to README.md but
there is no corresponding entry documenting this change in CHANGELOG.md.
Navigate to the [Unreleased] section in CHANGELOG.md and add an entry under the
appropriate category (typically under "Added" or "Changed") that documents the
addition of the DPG badge to the README as a documentation enhancement.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| <a href="https://digitalpublicgoods.net/r/docs-collaborative-text-editing"> | ||
| <img src="https://img.shields.io/badge/Verified-DPG-3333AB?logo=data:image/svg%2bxml;base64,PHN2ZyB3aWR0aD0iMzEiIGhlaWdodD0iMzMiIHZpZXdCb3g9IjAgMCAzMSAzMyIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KPHBhdGggZD0iTTE0LjIwMDggMjEuMzY3OEwxMC4xNzM2IDE4LjAxMjRMMTEuNTIxOSAxNi40MDAzTDEzLjk5MjggMTguNDU5TDE5LjYyNjkgMTIuMjExMUwyMS4xOTA5IDEzLjYxNkwxNC4yMDA4IDIxLjM2NzhaTTI0LjYyNDEgOS4zNTEyN0wyNC44MDcxIDMuMDcyOTdMMTguODgxIDUuMTg2NjJMMTUuMzMxNCAtMi4zMzA4MmUtMDVMMTEuNzgyMSA1LjE4NjYyTDUuODU2MDEgMy4wNzI5N0w2LjAzOTA2IDkuMzUxMjdMMCAxMS4xMTc3TDMuODQ1MjEgMTYuMDg5NUwwIDIxLjA2MTJMNi4wMzkwNiAyMi44Mjc3TDUuODU2MDEgMjkuMTA2TDExLjc4MjEgMjYuOTkyM0wxNS4zMzE0IDMyLjE3OUwxOC44ODEgMjYuOTkyM0wyNC44MDcxIDI5LjEwNkwyNC42MjQxIDIyLjgyNzdMMzAuNjYzMSAyMS4wNjEyTDI2LjgxNzYgMTYuMDg5NUwzMC42NjMxIDExLjExNzdMMjQuNjI0MSA5LjM1MTI3WiIgZmlsbD0id2hpdGUiLz4KPC9zdmc+Cg==" alt="DPG Badge"/> | ||
| </a> |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Search for CHANGELOG files in the repository and verify they contain an [Unreleased] entry
fd -i changelog -t f | head -5
# If found, check for [Unreleased] section and recent DPG-related entries
if [ -f "CHANGELOG.md" ]; then
echo "=== CHANGELOG.md content (first 50 lines) ==="
head -50 CHANGELOG.md
fiRepository: suitenumerique/docs
Length of output: 1630
🏁 Script executed:
# Check the git status/diff to see if the README.md DPG badge addition is new
git diff HEAD -- README.md | head -100Repository: suitenumerique/docs
Length of output: 157
🏁 Script executed:
# Check recent git history for README.md
git log --oneline -20 -- README.md
# Also check git status
git status README.mdRepository: suitenumerique/docs
Length of output: 265
Add CHANGELOG entry for the DPG badge addition to README.
The DPG badge was added to README.md (commit 5cedaa3), but no corresponding entry exists in the [Unreleased] section of CHANGELOG.md. Add an entry documenting this documentation enhancement.
🤖 Prompt for 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.
In `@README.md` around lines 20 - 22, The DPG badge link and image were added to
README.md but there is no corresponding entry documenting this change in
CHANGELOG.md. Navigate to the [Unreleased] section in CHANGELOG.md and add an
entry under the appropriate category (typically under "Added" or "Changed") that
documents the addition of the DPG badge to the README as a documentation
enhancement.
Purpose
This PR includes the new DPG badge in the README file, following the guide, and links to LaSuite Doc's profile page on the DPG Registry.
General requirements
Skip the checkbox below 👇 if you're fixing an issue or adding documentation
CI requirements
git commit --signoff(DCO compliance)git commit -S)<gitmoji>(type) title description## [Unreleased]section (if noticeable change)