Skip to content

✏️(docs) Add Add DPG badge to README#2440

Merged
AntoLC merged 1 commit into
suitenumerique:mainfrom
BolajiAyodeji:patch-1
Jun 23, 2026
Merged

✏️(docs) Add Add DPG badge to README#2440
AntoLC merged 1 commit into
suitenumerique:mainfrom
BolajiAyodeji:patch-1

Conversation

@BolajiAyodeji

@BolajiAyodeji BolajiAyodeji commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

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

  • Before submitting a PR for a new feature I made sure to contact the product manager

CI requirements

  • I made sure that all existing tests are passing
  • I have signed off my commits with git commit --signoff (DCO compliance)
  • I have signed my commits with my SSH or GPG key (git commit -S)
  • My commit messages follow the required format: <gitmoji>(type) title description
  • I have added a changelog entry under ## [Unreleased] section (if noticeable change)

@coderabbitai

coderabbitai Bot commented Jun 19, 2026

Copy link
Copy Markdown

Review Change Stack

Walkthrough

The README gains one new badge in its top banner section: an anchor linking to digitalpublicgoods.net that displays a "Verified-DPG-3333AB" shield image, inserted alongside the existing GitHub shield links at lines 20–22.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly describes the main change—adding a DPG badge to the README file, which aligns with the changeset summary.
Description check ✅ Passed The description is directly related to the changeset, explaining the purpose of adding the DPG badge and linking to relevant resources and guidelines.
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

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.

@virgile-dev

Copy link
Copy Markdown
Collaborator

Thanks @BolajiAyodeji I just launched the CI.
You'll know what you need to fix by looking at the errors.
Cheers,

@BolajiAyodeji BolajiAyodeji changed the title Add DPG badge to README ✏️(docs) Add Add DPG badge to README Jun 22, 2026
@BolajiAyodeji

Copy link
Copy Markdown
Contributor Author

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.
@AntoLC AntoLC self-requested a review June 23, 2026 08:06
@AntoLC AntoLC added the documentation Improvements or additions to documentation label Jun 23, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

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 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

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 33c5d653-fd89-43c2-b666-d643ba8fd7b8

📥 Commits

Reviewing files that changed from the base of the PR and between a087fcf and 5cedaa3.

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

Comment thread README.md
Comment on lines +20 to +22
<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>

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

📐 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
fi

Repository: 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 -100

Repository: 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.md

Repository: 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.

@AntoLC AntoLC merged commit 5cedaa3 into suitenumerique:main Jun 23, 2026
36 of 37 checks passed
@BolajiAyodeji BolajiAyodeji deleted the patch-1 branch June 23, 2026 10:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants