Skip to content

Link libtmux.org and the package registry from the READMEs - #794

Merged
tony merged 2 commits into
masterfrom
readme-registry-links
Oct 26, 2026
Merged

tony merged 2 commits into
masterfrom
readme-registry-links

Conversation

@tony

@tony tony commented Oct 26, 2026

Copy link
Copy Markdown
Member

Each README that introduces a package now links the port's docs home on libtmux.org and that package's page on PyPI, as badges under the title. The libtmux.org badge is on its own line in every README so it can become a plain link if preferred.

Release wording also drops "stable": nothing in libtmux is stable, and libtmux.org no longer publishes a stable docs version, so a release's docs live at its own version, which is the default.

  • docs(README) Link the README to libtmux.org

Checks: every new URL returns 200 (libtmux.org port homes 302), the README checks pass, and git diff origin/master -- '*README.md' | grep '^-' shows no removed README lines apart from deliberate rewording.

Tool use: a Sonnet sub-agent made the README commits; Claude Code reviewed them, wrote the docs workflow change where there is one, and opened this pull request. The maintainer reviews it before merge.

why: The README badge row links the current docs and PyPI but not the
libtmux.org home for the port, and the install heading calls a release
"Stable".

what:
- Add a libtmux.org badge to the badge row
- Label the install block "Release:" instead of "Stable release:"
@codecov

codecov Bot commented Oct 26, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 52.45%. Comparing base (e72b84f) to head (0813d07).

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #794      +/-   ##
==========================================
+ Coverage   52.37%   52.45%   +0.08%     
==========================================
  Files          26       26              
  Lines        3729     3729              
  Branches      747      747              
==========================================
+ Hits         1953     1956       +3     
+ Misses       1472     1469       -3     
  Partials      304      304              

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

why: The header row did not follow the shared libtmux badge order, and
carried a second workflow badge and a coverage badge that the standard
leaves out of the header.

what:
- Order the badges as tests, libtmux (PyPI version), libtmux.org docs,
  license
- Point the tests badge at the tests.yml workflow page
- Label the PyPI badge with the package name
- Drop the docs workflow badge and the codecov badge
- Use a static MIT license badge
@tony

tony commented Oct 26, 2026

Copy link
Copy Markdown
Member Author

Badge row is now CI, version, docs and license, the same four the other libtmux ports show (0813d07): tests, libtmux on PyPI, libtmux.org docs, MIT.

This drops two badges from the header:

  • The docs workflow badge: it was a second CI badge, and the docs link now goes to libtmux.org.
  • The codecov badge.

Say if either should stay and I'll put it back.

@tony
tony merged commit 886b1cd into master Oct 26, 2026
15 checks passed
@tony
tony deleted the readme-registry-links branch October 26, 2026 09:02
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