Skip to content

docs: restructure README top section to standard ecosystem layout - #4

Merged
petercorke merged 2 commits into
mainfrom
docs/standard-readme-layout
Oct 4, 2026
Merged

petercorke merged 2 commits into
mainfrom
docs/standard-readme-layout

Conversation

@petercorke

Copy link
Copy Markdown
Owner

Follows the layout documented in rvc-ecosystem's README.md (tagline, quick links, badges grouped into Status & Project Health / Ecosystem & Dependencies), matching RTB/MVTB/bdsim/sphinx-pyrunblock. Also fixes a stale license badge (was pointing at an unrelated repo's static badge), switches the downloads badge to pepy.tech per the ecosystem doc's note on rate limiting, and adds powered-by badges for NumPy/SciPy/Matplotlib, real dependencies that weren't previously badged.

Follows the layout documented in rvc-ecosystem's README.md (tagline, quick
links, badges in Status & Project Health / Ecosystem & Dependencies groups)
already used by RTB, MVTB, bdsim, and sphinx-pyrunblock.

Also fixes two stale details along the way:
- The license badge pointed at img.shields.io/github/license/Naereen/StrapDown.js.svg,
  a static badge for an unrelated repo, not pgraph-python's own MIT license.
- The downloads badge used shields.io's pypi/dw endpoint, which the ecosystem
  doc notes is subject to rate limiting; switched to pepy.tech.

Adds powered-by badges for NumPy, SciPy, and Matplotlib -- real dependencies
that weren't previously badged, matching the doc's "major packages used"
guidance.
@codecov

codecov Bot commented Sep 1, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 85.05%. Comparing base (ddfea14) to head (a1a610a).

Additional details and impacted files
@@           Coverage Diff           @@
##             main       #4   +/-   ##
=======================================
  Coverage   85.05%   85.05%           
=======================================
  Files           2        2           
  Lines         776      776           
=======================================
  Hits          660      660           
  Misses        116      116           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@codacy-production

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

@petercorke
petercorke merged commit a7f59f2 into main Oct 4, 2026
15 checks passed
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.

1 participant