Repository navigation
docs: make README links absolute so the PyPI page works - #59
Merged
Merged
Conversation
README.md is the PyPI long description, and 35 of its 51 links were relative, so on pypi.org they resolved under pypi.org/project/evalshift/ and 404ed. Point them at the files on GitHub (blob/main for files, tree/main for directories) and add a test that keeps them absolute. Homepage and Documentation now go to evalshift.dev and evalshift.dev/docs/cli instead of the GitHub repo. Co-Authored-By: Claude Opus 5.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
1 participant
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.
Why
README.mdis the PyPI long description. In the published 1.5.0 description, 35 of 51 links were relative (DOCS.md,docs/configuration.md,examples/agent/,LICENSE, …). On pypi.org they resolve underpypi.org/project/evalshift/…, which 404s. Separately, every project link (Homepage and Documentation included) pointed at GitHub.What
blob/main/<path>for files andtree/main/<path>for directories. Anchors such as#config-version-policyare kept. GitHub renders these the same as before.pyproject.toml:Homepage = https://www.evalshift.devandDocumentation = https://www.evalshift.dev/docs/cli. Repository, Issues and Changelog stay on GitHub.tests/unit/test_readme_links.py: fails on any relative link inREADME.md. It covers markdown inline links, images, reference definitions and HTMLhref/src, and ignores fenced code. It also checks thatreadme = "README.md"is still set, since that is the premise of the test.PyPI only picks this up on the next CLI release.
Verification
make ci: 3292 passed, 95.19% coverage.pre-commit run --all-filesis green.mainwith exactly the 35 relative links, and passes after the rewrite. Every rewritten target exists onmain.uv build+twine checkpass. The wheel METADATA has the newProject-URLs, and its description has 51 links, 0 relative.Companion: evalshift/evalshift-sdk (same Homepage/Documentation change).
🤖 Generated with Claude Code