docs: show that da-cli is on PyPI - #12
Merged
Merged
Conversation
The install instructions have been correct since #7, but nothing above the fold said the package was installable. The badge row — eight badges for CI, Python, licence, ruff, mypy, coverage, status and dependency count — never mentioned PyPI at all, so a visitor's first screen gave no sign that `pipx install da-sync` was an option. * PyPI version badge, first in the row, linking to the project page. * `pipx install da-sync` directly under the opening paragraph. * `Python 3.10+` becomes `pypi/pyversions`, which reads the classifiers instead of restating them, so it cannot drift from `requires-python`. It renders "3.10 | 3.11 | 3.12 | 3.13 | 3.14" — strictly more than the static badge said. The `Status: Beta` badge goes. The blockquote two lines below already says "Status: Beta" with more useful detail, and the row turns out to have a budget: check_discoverability requires "deviantart" inside the first twelve lines, and a ninth badge pushed the opening paragraph past it. Trimming the duplicate was the better fix; widening the rule would have traded a real SEO constraint for badge clutter. Verified: all three badge URLs render real data (pypi: v0.1.1, python: 3.10-3.14) rather than shields' "invalid" placeholder; the four checkers, markdownlint (pinned 0.45.0 + repo config) and lychee are clean; and the opening-lines rule was watched failing on a ninth badge before the trim. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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.
Problem
The install instructions have been correct since #7, and #11 fixed what PyPI
says about the project. This fixes what the project says about PyPI.
Nothing above the fold indicated the package was installable. The badge row —
eight badges covering CI, Python, licence, ruff, mypy, coverage, status and
dependency count — never mentioned PyPI, so a visitor's first screen gave no
sign that
pipx install da-syncexisted. (The name does appear further down,in the Install section; the gap was at the top.)
Solution
pipx install da-syncdirectly under the opening paragraph.Python 3.10+→pypi/pyversions, which reads the classifiers insteadof restating them, so it cannot drift from
requires-python. It renders3.10 | 3.11 | 3.12 | 3.13 | 3.14— strictly more than the static badge.Status: Beta. The blockquote two lines below already says itwith more detail.
That last one was forced, and the reason is worth recording: the badge row has
a budget.
check_discoverabilityrequiresdeviantartwithin the first twelvesource lines, and a ninth badge pushed the opening paragraph past it. Trimming
the duplicate beat widening the rule — that would have traded a real SEO
constraint for badge clutter.
Verification
pypi: v0.1.1andpython: 3.10 | 3.11 | 3.12 | 3.13 | 3.14— not shields'invalid/undefinedplaceholder, which is what a wrong package name yields.badge reproduced
FAIL 'deviantart' appears in the H1 or opening lines,27 passed / 1 failed. Restored, it is 28 passed / 0 failed.
check_doc_flags,check_doc_references,check_version_sync,check_discoverability— all pass.Note
The badge will not appear on the PyPI page until the next release, since a
description is frozen into the uploaded artifact. That is cosmetic and not
worth a release on its own — 0.1.1's description is already correct.
🤖 Generated with Claude Code