Skip to content

Migrate documentation for Package Collections to DocC #8589

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
bripeticca opened this issue May 1, 2025 · 0 comments · Fixed by #8715
Closed

Migrate documentation for Package Collections to DocC #8589

bripeticca opened this issue May 1, 2025 · 0 comments · Fixed by #8715

Comments

@bripeticca
Copy link
Contributor

Description

In an effort to create a consolidated single source for the swift package manager documentation, this issue will track the work to be done in moving the contents of PackageCollections.md into our DocC catalogue.

Expected behavior

No response

Actual behavior

No response

Steps to reproduce

No response

Swift Package Manager version/commit hash

No response

Swift & OS version (output of swift --version && uname -a)

No response

@bripeticca bripeticca self-assigned this May 6, 2025
bripeticca added a commit that referenced this issue Jun 4, 2025
The covers the porting of content for `PackageCollections.md` into our
DocC catalog and fixes #8589.

The new guide article for `PackageCollections` exists under
`Sources/PackageManagerDocs/Documentation.docc/PackageCollections.md`
and touches on creating, publishing, signing/protecting, and modifying
package collections. Below the overview there is a list of subcommands
available on the `swift package-collection` tool with links navigating
to the Swift commands documentation.

Each of the `PackageCollection` CLI commands have been augmented with
supplementary information about how to use the subcommand (if
applicable), all of which is taken from the original
`/Documentation/PackageCollections.md` markdown file.

Some links within these guides either still reference the old links in
the original `Documentation/PackageCollections.md` file or are
placeholders - both are marked with a `TODO` to update these links once
other issues under #8603 are completed and we can replace the links with
the appropriate DocC equivalent.

Some content in these guides are also taken from
`Sources/PackageCollectionsModel/Formats/v1`.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant