bytedance / bytedance/Protenix
PyPI project page renders repository-relative README links and images as 404
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.1k
- Forks
- 312
- PR merge metrics
- No merged PRs in 30d
Description
Problem
The PyPI long description is populated directly from README.md. The README contains 23 repository-relative link/image occurrences representing 21 unique targets.
On https://pypi.org/project/protenix/, these resolve under pypi.org/project/protenix/... or PyPI camo rather than the GitHub repository, and all 21 unique targets return 404.
Affected content includes:
- Protenix-v1/v2 technical reports
- input, model, training, benchmark, MSA, and data-preparation documentation
inference_demo.sh- CONTRIBUTING, CODE_OF_CONDUCT, and LICENSE
- all five README images
- local source links
- the vulnerability-reporting email
Two source links are also independently invalid in the GitHub README: protenix/openfold_local/ no longer exists, and the security email lacks a mailto: scheme.
Reproduction
- Open https://pypi.org/project/protenix/.
- Follow any repository-relative documentation target, for example the Protenix-v2 report (
docs/PX2.pdf) or training instructions (docs/training_inference_instructions.md). - Observe that the target resolves under PyPI and returns 404. The five repository-relative images similarly return 404 through PyPI camo.
Verified against commit 4c355be4553512f72453ecbfb65e69f4c35d1413 and the current PyPI 2.0.0 page.
Expected behavior
Links and images in the published long description should resolve to the canonical repository content, and the security email should open as an email link.
Impact
Users arriving from PyPI cannot access the main documentation, reports, license, contribution guide, security contact, or benchmark images.
Suggested fix
Use canonical absolute GitHub URLs for repository documents/scripts and raw.githubusercontent.com URLs for images, remove the obsolete local openfold_local link, and use mailto:sec@bytedance.com.
This would keep a single README source and fix GitHub, PyPI, wheel metadata, sdist metadata, and downstream renderers without adding a build dependency.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in README.md and compare its 23 repository-relative link and image occurrences with the published PyPI page. Update the documented targets as described, remove the obsolete openfold_local link, and make the security address a mailto link. Done means the documentation, scripts, images, repository links, and email resolve correctly from the PyPI long description.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Active
- Clarity
- Clearly specified
- Newbie friendliness
- 88/100