Migrate PackageDescription.md reference #8675
Open
Conversation
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
The content for `Documentation/PackageDescription.md` is currently hosted on https://docs.swift.org/package-manager/ and is considered legacy content to be removed. The newer version of this documentation is hosted at https://developer.apple.com/documentation/packagedescription for which the content is found under `Sources/PackageDescription/PackageDescription.docc/PackageDescription.md`. We'd like to direct users to this developer documentation from our DocC catalog, but since DocC does not currently support external linking to other DocC catalogs we can simply create an article in our catalog that provides a redirect link to above link.
|
@swift-ci please test |
|
@swift-ci please test |
|
@swift-ci please test windows |
heckj
approved these changes
May 16, 2025
There was a problem hiding this comment.
I tried to add a direct HTML style link under the ## Topics header, but DocC appears to be ignoring arbitrary HTML which is preventing that. Since we don't have a doc:... reference we can use to reference other DocC catalogs, I think using an article as a pass-through is the best we can arrange, even if that's a far worse experience for a reader.
Sources/PackageManagerDocs/Documentation.docc/PackageDescription.md
Outdated
Show resolved
Hide resolved
heckj
requested changes
May 16, 2025
- Change name of the developer documentation link to API documentation
|
@swift-ci please test |
bripeticca
requested review from
jakepetroules,
dschaefer2,
shawnhyam,
plemarquand,
owenv,
bkhouri,
cmcgee1024 and
daveyc123
as code owners
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.
The content for
Documentation/PackageDescription.mdis currently hosted on https://docs.swift.org/package-manager/ and is considered legacy content to be removed. The newer version of this documentation is hosted at https://developer.apple.com/documentation/packagedescription for which the content is found underSources/PackageDescription/PackageDescription.docc/PackageDescription.md.We'd like to direct users to this developer documentation from our DocC catalog, but since DocC does not currently support external linking to other DocC catalogs we can simply create an article in our catalog that provides a redirect link to above link.
Fixes #8590