Fix broken README documentation links - #10465
Open
mehuljariwala wants to merge 1 commit into
Open
Conversation
mehuljariwala
requested review from
bkhouri,
bripeticca,
cmcgee1024,
daveinglis,
daveyc123,
dschaefer2,
jakepetroules,
owenv,
plemarquand and
rconnell9
as code owners
August 31, 2026 05:12
Author
|
@swift-ci please test self hosted |
owenv
requested changes
Aug 31, 2026
owenv
left a comment
Contributor
There was a problem hiding this comment.
git diff --check also passes. No Swift source or generated documentation changed
How does this validate these changes? My understanding is that all it does is check for conflict markers and white space issues
Author
|
You are right: |
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.
Update the README to use the current canonical SwiftPM and PackageDescription documentation URLs.
Motivation:
Fixes #10463.
The README documentation links use the retired
docs.swift.org/swiftpm/...routing structure. Those routes now redirect to duplicated paths such aslatest/documentation/packagemanagerdocs/packagemanagerdocsand return HTTP 404.The Getting Started link first loads an HTML redirect page that points to the same broken route, so readers cannot reach the guide from the README.
Modifications:
Updated the four affected README links:
Each link now uses its canonical
docs.swift.org/latest/documentation/...destination with a trailing slash.Result:
README visitors are taken directly to the current official Swift documentation instead of a redirect chain ending in a 404 page.
Validation:
Followed each replacement URL with redirects enabled and confirmed HTTP 200 responses:
https://docs.swift.org/latest/documentation/packagemanagerdocs/gettingstarted/https://docs.swift.org/latest/documentation/packagemanagerdocs/https://docs.swift.org/latest/documentation/packagedescription/https://docs.swift.org/latest/documentation/packagemanagerdocs/releasenotes/The HTTP checks above validate the link changes. Separately,
git diff --checkpasses as a whitespace/conflict-marker sanity check; it does not validate URLs. No Swift source or generated documentation changed.