Skip to content

chore(docs): align badges and header layout#23

Open
eschaar wants to merge 6 commits intomainfrom
docs/readme-changelog-1-3-6
Open

chore(docs): align badges and header layout#23
eschaar wants to merge 6 commits intomainfrom
docs/readme-changelog-1-3-6

Conversation

@eschaar
Copy link
Copy Markdown
Owner

@eschaar eschaar commented Apr 22, 2026

Summary

  • Updated README and README-pypi badge/header rendering for consistency and correct status display.
  • Fixed PyPI version badge formatting to show the raw version value (no v prefix).
  • Fixed Verify/Security badges to show workflow status correctly for PR-triggered workflows.
  • Updated changelog with a new 1.3.6 section documenting these documentation and badge fixes.

Why

  • PyPI badge formatting and workflow badge status behavior were confusing (version prefix mismatch and “no status” behavior).
  • README-pypi header layout had visual issues (oversized logo, redundant title, badge placement).
  • Changelog needed an explicit 1.3.6 entry to capture these shipped documentation fixes.

Version impact

  • None
  • Patch
  • Minor
  • Major

Copilot AI review requested due to automatic review settings April 22, 2026 21:47
Copy link
Copy Markdown
Contributor

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

This PR updates repository documentation to standardize header/badge rendering across GitHub and PyPI, and records the changes in the changelog.

Changes:

  • Updated PyPI version badge to display the raw version value.
  • Adjusted Verify/Security workflow badges (intended to improve PR-status reporting).
  • Added a 1.3.6 changelog entry documenting the documentation/badge changes.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 5 comments.

File Description
README.md Updates PyPI + workflow badges in the GitHub README header block.
README-pypi.md Reworks the PyPI README header (logo + badges) and updates badge URLs.
CHANGELOG.md Adds a 1.3.6 entry describing the documentation/badge adjustments.

Comment thread README-pypi.md Outdated
Comment thread README-pypi.md Outdated
Comment thread CHANGELOG.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
eschaar and others added 5 commits April 22, 2026 23:55
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants