From 4c726d3418ee01c8545c01c6c508daf8cb5c5572 Mon Sep 17 00:00:00 2001 From: Bri Peticca Date: Thu, 15 May 2025 13:04:12 -0400 Subject: [PATCH 1/3] Migrate PackageDescription.md reference 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. --- .../Documentation.docc/PackageDescription.md | 5 +++++ .../Documentation.docc/SwiftPackageManager.md | 4 ++-- 2 files changed, 7 insertions(+), 2 deletions(-) create mode 100644 Sources/PackageManagerDocs/Documentation.docc/PackageDescription.md diff --git a/Sources/PackageManagerDocs/Documentation.docc/PackageDescription.md b/Sources/PackageManagerDocs/Documentation.docc/PackageDescription.md new file mode 100644 index 00000000000..2818c848b14 --- /dev/null +++ b/Sources/PackageManagerDocs/Documentation.docc/PackageDescription.md @@ -0,0 +1,5 @@ +# Package Description + +Create reusable code, organize it in a lightweight way, and share it across your projects and with other developers. + +For more information about the `PackageDescription` framework, please visit the [official developer documentation](https://developer.apple.com/documentation/packagedescription). diff --git a/Sources/PackageManagerDocs/Documentation.docc/SwiftPackageManager.md b/Sources/PackageManagerDocs/Documentation.docc/SwiftPackageManager.md index d6df794d206..e49d1cd1a3a 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/SwiftPackageManager.md +++ b/Sources/PackageManagerDocs/Documentation.docc/SwiftPackageManager.md @@ -26,8 +26,8 @@ The Swift Package Manager leets you share your code as a package, depend on and - - + ### Reference +- From cf47af892e6583da257c984aa572ce2d25d76f38 Mon Sep 17 00:00:00 2001 From: Bri Peticca Date: Thu, 15 May 2025 13:12:57 -0400 Subject: [PATCH 2/3] Fix extra space --- .../PackageManagerDocs/Documentation.docc/PackageDescription.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Sources/PackageManagerDocs/Documentation.docc/PackageDescription.md b/Sources/PackageManagerDocs/Documentation.docc/PackageDescription.md index 2818c848b14..e7a39f70224 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/PackageDescription.md +++ b/Sources/PackageManagerDocs/Documentation.docc/PackageDescription.md @@ -2,4 +2,4 @@ Create reusable code, organize it in a lightweight way, and share it across your projects and with other developers. -For more information about the `PackageDescription` framework, please visit the [official developer documentation](https://developer.apple.com/documentation/packagedescription). +For more information about the `PackageDescription` framework, please visit the [official developer documentation](https://developer.apple.com/documentation/packagedescription). From 91ac146ced64167d0d701e4240a32aa1a706d52c Mon Sep 17 00:00:00 2001 From: Bri Peticca Date: Fri, 16 May 2025 14:51:47 -0400 Subject: [PATCH 3/3] Address PR comments - Change name of the developer documentation link to API documentation --- .../PackageManagerDocs/Documentation.docc/PackageDescription.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Sources/PackageManagerDocs/Documentation.docc/PackageDescription.md b/Sources/PackageManagerDocs/Documentation.docc/PackageDescription.md index e7a39f70224..740b598acf1 100644 --- a/Sources/PackageManagerDocs/Documentation.docc/PackageDescription.md +++ b/Sources/PackageManagerDocs/Documentation.docc/PackageDescription.md @@ -2,4 +2,4 @@ Create reusable code, organize it in a lightweight way, and share it across your projects and with other developers. -For more information about the `PackageDescription` framework, please visit the [official developer documentation](https://developer.apple.com/documentation/packagedescription). +For more information about the `PackageDescription` framework, please visit the [API documentation](https://developer.apple.com/documentation/packagedescription).