fix: update five dead links in the guide - #804
Merged
Merged
Conversation
Hatch moved its build docs, the Scientific Python testing guide moved to learn.scientific-python.org, the packaging template tutorial now lives inside this guide, and hackergrrl/art-of-readme was deleted (linked to its Wayback snapshot).
Contributor
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
All five targeted links are updated consistently to appropriate destinations without functional risk.
Review effort: Balanced
Findings: None
What changed in this PR
Updates five dead documentation links to valid internal, current, or archived destinations.
Changes:
- Replaces obsolete Hatchling and Scientific Python URLs.
- Uses an internal relative link for the packaging tutorial.
- Links the deleted Art of README repository to an archived snapshot.
| File | Description |
|---|---|
tests/run-tests.md |
Updates tutorial and testing-guide links. |
tests/run-tests-nox.md |
Updates the Scientific Python testing link. |
documentation/repository-files/readme-file-best-practices.md |
Replaces a deleted repository with its archived snapshot. |
documentation/glossary.md |
Updates the Hatchling documentation link. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Member
|
@all-contributors please add rmz-oz for doc |
Contributor
|
I've put up a pull request to add @rmz-oz! 🎉 |
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.
Five links in the guide return 404. This updates them:
documentation/glossary.md(Hatchling)hatch.pypa.io/latest/backend/hatch.pypa.io/latest/config/build/tests/run-tests.mdpyopensci.org/tutorials/create-python-package.html../tutorials/create-python-package(the tutorial is in this guide)tests/run-tests.mdscientific-python.org/tools/testinglearn.scientific-python.org/development/principles/testing/tests/run-tests-nox.mddocumentation/repository-files/readme-file-best-practices.mdgithub.com/hackergrrl/art-of-readmeThe art-of-readme repository was deleted by its author and I couldn't find a new home for it, so I pointed at the archived copy. Happy to remove the line instead if you prefer.
Checks: every new URL returns 200;
nox -s docs-testpasses, and the only warning in these files (run-tests.md:191, aliteralincludestart-at pattern) is on a line this PR does not touch. The relative link renders as../tutorials/create-python-package.html.