docs: align release documentation#119
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates repository documentation to match the features and breaking changes released in v3.4.0, including new badge customization query parameters and the SVG template placeholder migration noted in issue #118.
Changes:
- Document the newly supported badge styles and URI query options (
labelColor,logo,logoColor,social, 3-digit hex colors) inREADME.md. - Add missing
v3.3.0notes and complete thev3.4.0changelog entry, including template placeholder migration notes. - Introduce
AGENTS.mdwith repository structure, commands, CI expectations, and testing notes for coding agents.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| README.md | Expands user-facing docs for styles, badge customization options, and custom-template migration guidance. |
| CHANGELOG.md | Adds v3.4.0 and missing v3.3.0 release notes plus version reference links. |
| AGENTS.md | Adds contributor/agent guidance covering repo structure, commands, CI, style, and testing practices. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
garak
approved these changes
May 28, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR aligns the documentation with the features released in
v3.4.0.It documents the new badge customization options introduced by #117:
labelColorlogologoColorsocialstyleIt also updates the changelog with the missing
v3.3.0release notes and completes thev3.4.0entry based on the published GitHub release notes.Custom Template Migration
v3.4.0changed the SVG template placeholders:vendorStartPosition->vendorStartXvalueStartPosition->valueStartXThis PR documents that migration path for users maintaining custom SVG templates.
Closes #118.
/cc @aptyp4uk1337 @GregOriol