Skip to content

Fix broken links on PyPI page#174

Open
mtorp wants to merge 1 commit intomainfrom
fix/readme-pypi-links
Open

Fix broken links on PyPI page#174
mtorp wants to merge 1 commit intomainfrom
fix/readme-pypi-links

Conversation

@mtorp
Copy link
Contributor

@mtorp mtorp commented Mar 26, 2026

Summary

  • All relative links in README.md (to docs/, examples/config/, workflows/) are broken on the PyPI page because PyPI renders the markdown but has no access to the repository file tree
  • Replaced all 16 relative links with absolute GitHub URLs pointing to the main branch so they resolve correctly on both PyPI and GitHub

Test plan

  • Verify links work on the current PyPI page after next release
  • Verify links still work when viewing the README on GitHub

PyPI renders the README but has no access to the repository file tree,
so all relative links (docs/, examples/config/, workflows/) resolved
against pypi.org and returned 404s. Replace with absolute URLs pointing
to the main branch on GitHub.
@mtorp mtorp requested a review from a team as a code owner March 26, 2026 10:58
@github-actions
Copy link

🚀 Preview package published!

Install with:

pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple socketsecurity==2.2.80.dev1

Docker image: socketdev/cli:pr-174

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