swiftlang / swiftlang/docs

curate API reference content into Swift Package Manager docs

Open
#134 0 comments 0 reactions 1 assignee View on GitHub

@heckj is already working on this.

Since Aug 7, 2026.

content migration
Dominant language
Python
Stars
28
Forks
5
Avg merge
18h 33m
Merged PRs (30d)
18

Description

Page URL

https://docs.swift.org/latest/documentation/packagemanagerdocs

Description

Following up from PR https://github.com/swiftlang/docs/pull/133, which suppressed the PackageDescription and PackagePlugin API reference documentation from the combined collections, work to embed the content (or links to the content) for those reference API collections.

The symbols are actively included in the combined documentation at the tail end of this process, but I think in order to work around DocC' combined limitations where, we'll need to create a slightly custom build setup:

  • build and generate all the relevant symbol graphs for these APIs
  • when we build the packageManagerDocs collection, include references to those additional symbol graph collections
  • replicate the curation and content from their DocC catalogs into the catalog with PackageManagerDocs to "embed" that content as API reference within it. The standard library has a precedent of doing this using an "API Topic Group", which presents as a heading with disclosure affordance that expands to let you drill down and view into the content from a human navigation perspective.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.