docs: add a badge block and link the README title to the docs site - #30
Merged
Conversation
Modelled on jebel-quant/jquantstats, adapted to this repo: PyPI version, MIT licence, the four supported Python versions, CI, coverage, ruff, uv, CodeFactor, OpenSSF Scorecard, the rhiza template ref, PyPI downloads and the paper PDF. Every endpoint was probed before being added, so none of them render as a broken image. That includes the three that are specific to this repo and could not simply be copied across: the coverage badge and HTML report on Pages, the `cvx-quadprog` project on PyPI, and `quadprog.pdf` on the `paper` branch. The H1 gets the same treatment as the inspiration -- linked name plus a tagline. The tagline is a trimmed form of the `description` in pyproject.toml, so the headline and the package metadata agree rather than drifting apart. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the project’s top-level README to improve presentation and discoverability by adding a badge block and linking the H1 title to the published documentation site.
Changes:
- Replace the plain
# cvx-quadprogheader with a linked H1 that includes a short tagline. - Add a set of status/metadata badges (PyPI, license, Python versions, CI, coverage, tooling, etc.) near the top of the README.
Suppressed comments (1)
README.md:16
- There is an empty line before the Paper badge, which splits it into a new paragraph/row while the other badges are contiguous. If the goal is a single badge block, remove the blank line to keep the layout consistent.
[](https://pepy.tech/project/cvx-quadprog)
[](https://github.com/jebel-quant/quadprog/blob/paper/quadprog.pdf)
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+3
to
+6
| [](https://pypi.org/project/cvx-quadprog/) | ||
|
|
||
| [](LICENSE) | ||
| [](https://www.python.org/) |
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.
Adds a badge block to the README, modelled on
jebel-quant/jquantstats and adapted
to this repo.
Badges
PyPI version · MIT licence · Python 3.11–3.14 · CI · Coverage · ruff · uv ·
CodeFactor · OpenSSF Scorecard · rhiza template ref · PyPI downloads · Paper
Every endpoint was probed for a 200 before being added, so none of them render
as a broken image. That mattered most for the ones that are specific to this repo
and could not simply be copied from the inspiration:
jebel-quant.github.io/quadprog/coverage-badge.svg→reports/html-coverage/cvx-quadprogproject, notquadprogquadprog.pdfon thepaperbranch, published byrhiza_paper.yml$.refread live out of.rhiza/template.ymlCodeFactor was initially left out — the repo returned 404 there and a badge
pointing at an unregistered project is worse than no badge. It has since been
registered and now returns 200, so it is included.
The mutation badge is deliberately not here.
rhiza_mutation.ymlis theworkflow that would publish one, and it stays skipped in this repo (see the
comment at the top of
.github/workflows/mutation.yml); the repo-owned mutationjob gates on a survivor baseline instead and publishes nothing to Pages.
H1
Same treatment as the inspiration — linked name plus a tagline:
# [cvx-quadprog](https://jebel-quant.github.io/quadprog): Goldfarb/Idnani QP in NumPy and SciPyThe tagline is a trimmed form of the
descriptioninpyproject.toml, so theheadline and the package metadata say the same thing rather than drifting apart.
The docs site is already declared at
mkdocs.yml:6.Verification
make fmt— all 21 hooks pass, markdownlint included (MD013 is disabled, so thelong badge lines are fine)
make rhiza-test— 39 passed, 1 skipped; this is the suite that validates theREADME's bash fragments and Python blocks
Docs only — no source, test or config changes.
🤖 Generated with Claude Code