initial, simple SDK documentation #9004
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
heckj
requested review from
jakepetroules,
dschaefer2,
shawnhyam,
bripeticca,
plemarquand,
owenv,
bkhouri,
cmcgee1024 and
daveyc123
as code owners
|
@swift-ci please test |
bripeticca
approved these changes
Aug 8, 2025
|
@swift-ci please test windows |
jakepetroules
approved these changes
Aug 8, 2025
|
|
||
| Additionally, the Swift project provides a tooling repository called [swift-sdk-generator](https://github.com/swiftlang/swift-sdk-generator) that you can use to create a custom SDK for your preferred platform. | ||
|
|
||
| For more information on the introduction of Swift SDKs, refer to the Swift evolution proposal [SE-0387](https://github.com/swiftlang/swift-evolution/blob/main/proposals/0387-cross-compilation-destinations.md). |
There was a problem hiding this comment.
I'm not sure linking to SE proposals as documentation is the best idea as a form of documentation, since they can become stale over time or be lacking in details we want to communicate. This seems like a good addition for now, although as a follow-on I think we should probably say something more like "was introduced in SE-0387" (with the link), but then go on to repeat the relevant parts here in detail along with any additional information we want to communicate.
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.
Provides some basic detail for Swift cross-compilation SDKs, referencing the installation links on swift.org, the evolution proposal, and the SDK generator code.
resolves #8864, to finalize the documentation of the CLI commands